haystack/docs/pydoc/config/routers_api.yml

36 lines
1.0 KiB
YAML
Raw Normal View History

loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack/components/routers]
2024-03-13 12:30:13 +01:00
modules:
[
"conditional_router",
"file_type_router",
"metadata_router",
"text_language_router",
"transformers_text_router",
"zero_shot_text_router",
2024-03-13 12:30:13 +01:00
]
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:
2024-03-13 12:30:13 +01:00
type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
docs: review `Routers` docstrings (#7234) * wip * review routers * small fixes * Update haystack/components/routers/conditional_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/conditional_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/file_type_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/file_type_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/file_type_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/file_type_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/metadata_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/metadata_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/text_language_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/text_language_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> * Update haystack/components/routers/text_language_router.py Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com> --------- Co-authored-by: Madeesh Kannan <shadeMe@users.noreply.github.com>
2024-02-28 11:26:22 +01:00
excerpt: Routers is a group of components that route queries or Documents to other components that can handle them best.
category_slug: haystack-api
title: Routers
slug: routers-api
order: 140
markdown:
descriptive_class_title: false
classdef_code_block: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: routers_api.md