diff --git a/.github/workflows/docs-website-test-docs-snippets.yml b/.github/workflows/docs-website-test-docs-snippets.yml index 8b6f0b6af9..16864c84dd 100644 --- a/.github/workflows/docs-website-test-docs-snippets.yml +++ b/.github/workflows/docs-website-test-docs-snippets.yml @@ -24,6 +24,7 @@ jobs: AZURE_OPENAI_AD_TOKEN: ${{ secrets.AZURE_OPENAI_AD_TOKEN }} AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }} CORE_AZURE_CS_ENDPOINT: ${{ secrets.CORE_AZURE_CS_ENDPOINT }} + HF_API_TOKEN: ${{ secrets.HUGGINGFACE_API_KEY }} OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} SERPERDEV_API_KEY: ${{ secrets.SERPERDEV_API_KEY }} diff --git a/haystack/components/generators/hugging_face_local.py b/haystack/components/generators/hugging_face_local.py index e599dd4bf1..290bc1a11b 100644 --- a/haystack/components/generators/hugging_face_local.py +++ b/haystack/components/generators/hugging_face_local.py @@ -29,7 +29,7 @@ class HuggingFaceLocalGenerator: LLMs running locally may need powerful hardware. ### Usage example - + ```python from haystack.components.generators import HuggingFaceLocalGenerator @@ -40,7 +40,7 @@ class HuggingFaceLocalGenerator: ) print(generator.run("Who is the best American actor?")) - # {'replies': ['John Cusack']} + # >> {'replies': ['John Cusack']} ``` """ diff --git a/haystack/components/rankers/sentence_transformers_diversity.py b/haystack/components/rankers/sentence_transformers_diversity.py index e888e4c0f2..994180c552 100644 --- a/haystack/components/rankers/sentence_transformers_diversity.py +++ b/haystack/components/rankers/sentence_transformers_diversity.py @@ -99,7 +99,7 @@ class SentenceTransformersDiversityRanker: if a score is present. ### Usage example - + ```python from haystack import Document from haystack.components.rankers import SentenceTransformersDiversityRanker diff --git a/haystack/components/rankers/transformers_similarity.py b/haystack/components/rankers/transformers_similarity.py index a40d08ec05..87c94510fe 100644 --- a/haystack/components/rankers/transformers_similarity.py +++ b/haystack/components/rankers/transformers_similarity.py @@ -35,7 +35,7 @@ class TransformersSimilarityRanker: additional features. ### Usage example - + ```python from haystack import Document from haystack.components.rankers import TransformersSimilarityRanker diff --git a/haystack/components/routers/llm_messages_router.py b/haystack/components/routers/llm_messages_router.py index 09310d6024..126924227e 100644 --- a/haystack/components/routers/llm_messages_router.py +++ b/haystack/components/routers/llm_messages_router.py @@ -20,7 +20,7 @@ class LLMMessagesRouter: This component can be used with general-purpose LLMs and with specialized LLMs for moderation like Llama Guard. ### Usage example - + ```python from haystack.components.generators.chat import HuggingFaceAPIChatGenerator from haystack.components.routers.llm_messages_router import LLMMessagesRouter diff --git a/haystack/components/routers/zero_shot_text_router.py b/haystack/components/routers/zero_shot_text_router.py index b223829e3c..602c5210f2 100644 --- a/haystack/components/routers/zero_shot_text_router.py +++ b/haystack/components/routers/zero_shot_text_router.py @@ -23,7 +23,7 @@ class TransformersZeroShotTextRouter: Specify the set of labels for categorization when initializing the component. ### Usage example - + ```python from haystack import Document from haystack.document_stores.in_memory import InMemoryDocumentStore