diff --git a/docs-website/reference/haystack-api/audio_api.md b/docs-website/reference/haystack-api/audio_api.md index 38fa4d7692..6eeebb6543 100644 --- a/docs-website/reference/haystack-api/audio_api.md +++ b/docs-website/reference/haystack-api/audio_api.md @@ -18,7 +18,7 @@ For the supported audio formats, languages, and other parameters, see the ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.audio import LocalWhisperTranscriber diff --git a/docs-website/reference/haystack-api/connectors_api.md b/docs-website/reference/haystack-api/connectors_api.md index 136cd6c38c..af9269b612 100644 --- a/docs-website/reference/haystack-api/connectors_api.md +++ b/docs-website/reference/haystack-api/connectors_api.md @@ -19,8 +19,7 @@ arguments to it from a Haystack pipeline run method or by other components in a pass input arguments to this component. Example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.utils import Secret @@ -166,8 +165,7 @@ Can be through the `SERPERDEV_API_KEY` environment variable or by directly assig variable in the code. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python import json diff --git a/docs-website/reference/haystack-api/converters_api.md b/docs-website/reference/haystack-api/converters_api.md index 4d7cc317d1..0ec23e70c2 100644 --- a/docs-website/reference/haystack-api/converters_api.md +++ b/docs-website/reference/haystack-api/converters_api.md @@ -20,7 +20,7 @@ and a Document Intelligence or Cognitive Services resource. For help with settin ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python import os @@ -379,7 +379,7 @@ Converts files to FileContent objects to be included in ChatMessage objects. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.converters import FileToFileContent @@ -537,7 +537,7 @@ Documents are expected to have metadata containing: ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -1740,8 +1740,7 @@ For more options on running Tika, see the [official documentation](https://github.com/apache/tika-docker/blob/main/README.md#usage). Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.converters.tika import TikaDocumentConverter diff --git a/docs-website/reference/haystack-api/embedders_api.md b/docs-website/reference/haystack-api/embedders_api.md index 6d58da62c0..3cca13c9ae 100644 --- a/docs-website/reference/haystack-api/embedders_api.md +++ b/docs-website/reference/haystack-api/embedders_api.md @@ -16,7 +16,7 @@ Calculates document embeddings using OpenAI models deployed on Azure. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -139,7 +139,7 @@ Embeds strings using OpenAI models deployed on Azure. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import AzureOpenAITextEmbedder @@ -257,7 +257,7 @@ Use it with the following Hugging Face APIs: #### With free serverless inference API -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder @@ -278,7 +278,7 @@ print(result["documents"][0].embedding) #### With paid inference endpoints -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder @@ -299,7 +299,7 @@ print(result["documents"][0].embedding) #### With self-hosted text embeddings inference -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPIDocumentEmbedder @@ -443,7 +443,7 @@ Use it with the following Hugging Face APIs: #### With free serverless inference API -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPITextEmbedder @@ -460,7 +460,7 @@ print(text_embedder.run("I love pizza!")) #### With paid inference endpoints -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPITextEmbedder @@ -476,7 +476,7 @@ print(text_embedder.run("I love pizza!")) #### With self-hosted text embeddings inference -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import HuggingFaceAPITextEmbedder @@ -600,7 +600,7 @@ The embedding of each Document is stored in the `embedding` field of the Documen ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -756,7 +756,7 @@ Computes document embeddings using OpenAI models. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -902,7 +902,7 @@ You can use it to embed user query and send it to an embedding Retriever. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import OpenAITextEmbedder @@ -1042,7 +1042,7 @@ and send them to DocumentWriter to write into a Document Store. ### Usage example: -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -1195,7 +1195,7 @@ and send them to DocumentWriter to write a into a Document Store. ### Usage example: -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document @@ -1327,8 +1327,7 @@ Embeds strings using sparse embedding models from Sentence Transformers. You can use it to embed user query and send it to a sparse embedding retriever. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import SentenceTransformersSparseTextEmbedder @@ -1450,8 +1449,7 @@ Embeds strings using Sentence Transformers models. You can use it to embed user query and send it to an embedding retriever. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.embedders import SentenceTransformersTextEmbedder diff --git a/docs-website/reference/haystack-api/extractors_api.md b/docs-website/reference/haystack-api/extractors_api.md index 86199d97bd..012e426349 100644 --- a/docs-website/reference/haystack-api/extractors_api.md +++ b/docs-website/reference/haystack-api/extractors_api.md @@ -466,8 +466,7 @@ that contains an NER component. Annotations are stored as metadata in the documents. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document diff --git a/docs-website/reference/haystack-api/generators_api.md b/docs-website/reference/haystack-api/generators_api.md index bd11a1db80..9b416795a3 100644 --- a/docs-website/reference/haystack-api/generators_api.md +++ b/docs-website/reference/haystack-api/generators_api.md @@ -27,7 +27,7 @@ For details on OpenAI API parameters, see ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators import AzureOpenAIGenerator @@ -170,7 +170,7 @@ For details on OpenAI API parameters, see ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import AzureOpenAIChatGenerator @@ -388,7 +388,7 @@ For details on OpenAI API parameters, see ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import AzureOpenAIResponsesChatGenerator @@ -701,7 +701,7 @@ format for input and output. Use it to generate text with Hugging Face APIs: #### With the serverless inference API (Inference Providers) - free tier available -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import HuggingFaceAPIChatGenerator @@ -727,7 +727,7 @@ print(result) #### With the serverless inference API (Inference Providers) and text+image input -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import HuggingFaceAPIChatGenerator @@ -756,7 +756,7 @@ print(result) #### With paid inference endpoints -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import HuggingFaceAPIChatGenerator @@ -776,7 +776,7 @@ print(result) #### With self-hosted text generation inference -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import HuggingFaceAPIChatGenerator @@ -955,7 +955,7 @@ LLMs running locally may need powerful hardware. ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators.chat import HuggingFaceLocalChatGenerator @@ -1876,7 +1876,7 @@ Use the `HuggingFaceAPIChatGenerator` component, which supports the `chat_comple #### With Hugging Face Inference Endpoints -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators import HuggingFaceAPIGenerator @@ -1892,7 +1892,7 @@ print(result) #### With self-hosted text generation inference -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators import HuggingFaceAPIGenerator @@ -1910,7 +1910,7 @@ Be aware that this example might not work as the Hugging Face Inference API no l `text_generation` endpoint. Use the `HuggingFaceAPIChatGenerator` for generative models through the `chat_completion` endpoint. -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.generators import HuggingFaceAPIGenerator diff --git a/docs-website/reference/haystack-api/image_converters_api.md b/docs-website/reference/haystack-api/image_converters_api.md index fec72ee0f1..17bef04682 100644 --- a/docs-website/reference/haystack-api/image_converters_api.md +++ b/docs-website/reference/haystack-api/image_converters_api.md @@ -24,7 +24,7 @@ Documents are expected to have metadata containing: ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document diff --git a/docs-website/reference/haystack-api/rankers_api.md b/docs-website/reference/haystack-api/rankers_api.md index 1c7491fdfb..a63d2830c5 100644 --- a/docs-website/reference/haystack-api/rankers_api.md +++ b/docs-website/reference/haystack-api/rankers_api.md @@ -28,8 +28,7 @@ It can be used with a Text Embeddings Inference (TEI) API endpoint: - [Hugging Face Inference Endpoints](https://huggingface.co/inference-endpoints) Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import Document diff --git a/docs-website/reference/haystack-api/routers_api.md b/docs-website/reference/haystack-api/routers_api.md index a4388360c9..480bf7636c 100644 --- a/docs-website/reference/haystack-api/routers_api.md +++ b/docs-website/reference/haystack-api/routers_api.md @@ -867,7 +867,7 @@ The labels are specific to each model and can be found it its description on Hug ### Usage example -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.core.pipeline import Pipeline diff --git a/docs-website/reference/haystack-api/tools_api.md b/docs-website/reference/haystack-api/tools_api.md index 17a34306d0..ebb0615607 100644 --- a/docs-website/reference/haystack-api/tools_api.md +++ b/docs-website/reference/haystack-api/tools_api.md @@ -35,7 +35,7 @@ Below is an example of creating a ComponentTool from an existing SerperDevWebSea ## Usage Example: -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack import component, Pipeline diff --git a/docs-website/reference/haystack-api/utils_api.md b/docs-website/reference/haystack-api/utils_api.md index a84eff64b3..9f27f94db9 100644 --- a/docs-website/reference/haystack-api/utils_api.md +++ b/docs-website/reference/haystack-api/utils_api.md @@ -944,8 +944,7 @@ request_with_retry( Executes an HTTP request with a configurable exponential backoff retry on failures. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.utils import request_with_retry diff --git a/docs-website/reference/haystack-api/websearch_api.md b/docs-website/reference/haystack-api/websearch_api.md index 3f6ff616f6..0ac65e76cc 100644 --- a/docs-website/reference/haystack-api/websearch_api.md +++ b/docs-website/reference/haystack-api/websearch_api.md @@ -13,8 +13,7 @@ slug: "/websearch-api" Uses [SearchApi](https://www.searchapi.io/) to search the web for relevant documents. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.websearch import SearchApiWebSearch @@ -137,8 +136,7 @@ Uses [Serper](https://serper.dev/) to search the web for relevant documents. See the [Serper Dev website](https://serper.dev/) for more details. Usage example: - -{/* test-ignore */} +{/\* test-ignore \*/} ```python from haystack.components.websearch import SerperDevWebSearch