From 8b1107266e0af132ea36d23d270d042fc5a22c99 Mon Sep 17 00:00:00 2001 From: shadeMe Date: Wed, 20 Nov 2024 12:24:54 +0100 Subject: [PATCH] doc: Update doc configs --- docs/pydoc/config/document_stores_api.yml | 32 +++++++++++++++++++++++ docs/pydoc/config/retrievers_api.yml | 6 +++-- 2 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 docs/pydoc/config/document_stores_api.yml diff --git a/docs/pydoc/config/document_stores_api.yml b/docs/pydoc/config/document_stores_api.yml new file mode 100644 index 00000000..009add33 --- /dev/null +++ b/docs/pydoc/config/document_stores_api.yml @@ -0,0 +1,32 @@ +loaders: + - type: haystack_pydoc_tools.loaders.CustomPythonLoader + search_path: [../../../] + modules: + [ + "haystack_experimental.document_stores.in_memory.document_store", + "haystack_experimental.document_stores.opensearch.document_store", + "haystack_experimental.document_stores.types.protocol", + ] + 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.ReadmeCoreRenderer + excerpt: Stores your texts and meta data and provides them to the Retriever at query time. + category_slug: experiments-api + title: Document Stores + slug: experimental-document-stores-api + order: 160 + markdown: + descriptive_class_title: false + classdef_code_block: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: document_stores_api.md diff --git a/docs/pydoc/config/retrievers_api.yml b/docs/pydoc/config/retrievers_api.yml index 4f16f6aa..1a449671 100644 --- a/docs/pydoc/config/retrievers_api.yml +++ b/docs/pydoc/config/retrievers_api.yml @@ -4,7 +4,9 @@ loaders: modules: [ "haystack_experimental.components.retrievers.auto_merging_retriever", - "haystack_experimental.components.retrievers.chat_message_retriever" + "haystack_experimental.components.retrievers.chat_message_retriever", + "haystack_experimental.components.retrievers.opensearch.bm25_retriever", + "haystack_experimental.components.retrievers.opensearch.embedding_retriever", ] ignore_when_discovered: ["__init__"] processors: @@ -28,4 +30,4 @@ renderer: descriptive_module_title: true add_method_class_prefix: true add_member_class_prefix: false - filename: experimental_retrievers_api.md \ No newline at end of file + filename: experimental_retrievers_api.md