haystack/docs/pydoc/config/embedders_api.yml
Massimiliano Pippi 27d0b28d06
chore: rename categories in the API docs (#6885)
* rename API categories

* fix

* update slugs

* rename files for consistency

* fix category ID

* try getting the right version
2024-02-01 16:47:26 +01:00

37 lines
1.1 KiB
YAML

loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack/components/embedders]
modules:
[
"azure_document_embedder",
"azure_text_embedder",
"hugging_face_tei_document_embedder",
"hugging_face_tei_text_embedder",
"openai_document_embedder",
"openai_text_embedder",
"sentence_transformers_document_embedder",
"sentence_transformers_text_embedder"
]
ignore_when_discovered: ["__init__"]
processors:
- type: filter
expression:
documented_only: true
do_not_filter_modules: false
skip_empty_modules: true
- type: smart
- type: crossref
renderer:
type: haystack_pydoc_tools.renderers.ReadmePreviewRenderer
excerpt: Transforms queries into vectors to look for similar or relevant Documents.
category_slug: haystack-api
title: Embedders
slug: embedders-api
order: 60
markdown:
descriptive_class_title: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: embedders_api.md