haystack/docs/pydoc/config/prompt-node.yml

loaders:
  - type: python
    search_path: [../../../haystack/nodes/prompt]
    modules:
      [
        "prompt_node",
        "prompt_model",
        "prompt_template",
        "shapers",
      ]
    ignore_when_discovered: ["__init__"]
processors:
  - type: filter
    expression:
    documented_only: true
    do_not_filter_modules: false
    skip_empty_modules: true
  - type: filter
    expression: "name not in ['PromptTemplateValidationError', 'PromptModelInvocationLayer', 'StopWordsCriteria', 'HFLocalInvocationLayer', 'OpenAIInvocationLayer', '_ValidationVisitor', '_FstringParamsTransformer']"
  - type: smart
  - type: crossref
renderer:
  type: renderers.ReadmeRenderer
  excerpt: Uses Large Language Models directly in your pipelines.
  category_slug: haystack-classes
  title: PromptNode API
  slug: prompt-node-api
  order: 115
  markdown:
    descriptive_class_title: false
    descriptive_module_title: true
    add_method_class_prefix: true
    add_member_class_prefix: false
    filename: prompt_node_api.md
chore: adding template for prompt node (#3738) 2022-12-21 19:13:57 +00:00			`loaders:`
			`- type: python`
re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00			`search_path: [../../../haystack/nodes/prompt]`
feat: Add Cohere PromptNode invocation layer (#4827) * Add CohereInvocationLayer --------- Co-authored-by: bogdankostic <bogdankostic@web.de> 2023-05-12 17:50:09 +02:00			`modules:`
docs: fix Prompt_Node and Pipelines API reference (#4858) * fix: Prompt_Node and Pipelines API reference * deleted invocation layers 2023-05-09 19:04:55 +02:00			`[`
			`"prompt_node",`
			`"prompt_model",`
			`"prompt_template",`
			`"shapers",`
			`]`
ci: Refactor docs config and generation (#4280) * Change docs yml category config * Update docs renderers to fetch categories from Readme.io * Update readme_sync.yml to handle new docs rendering * Remove unecessary script and related workflow step * Fix sys.exits 2023-03-01 09:51:02 +01:00			`ignore_when_discovered: ["__init__"]`
chore: adding template for prompt node (#3738) 2022-12-21 19:13:57 +00:00			`processors:`
			`- type: filter`
re-organize pydoc config files (#4042) 2023-02-03 12:51:10 +01:00			`expression:`
chore: adding template for prompt node (#3738) 2022-12-21 19:13:57 +00:00			`documented_only: true`
			`do_not_filter_modules: false`
			`skip_empty_modules: true`
docs: Remove some classes regarding PromptNode from API reference docs (#4132) 2023-02-10 15:56:38 +01:00			`- type: filter`
[Docs] Hide api classes in prompt_node (#4869) * hide api classes in prompt_node * add jsonconverter to docs 2023-05-10 10:56:46 +02:00			`expression: "name not in ['PromptTemplateValidationError', 'PromptModelInvocationLayer', 'StopWordsCriteria', 'HFLocalInvocationLayer', 'OpenAIInvocationLayer', '_ValidationVisitor', '_FstringParamsTransformer']"`
chore: adding template for prompt node (#3738) 2022-12-21 19:13:57 +00:00			`- type: smart`
			`- type: crossref`
			`renderer:`
ci: Refactor docs config and generation (#4280) * Change docs yml category config * Update docs renderers to fetch categories from Readme.io * Update readme_sync.yml to handle new docs rendering * Remove unecessary script and related workflow step * Fix sys.exits 2023-03-01 09:51:02 +01:00			`type: renderers.ReadmeRenderer`
			`excerpt: Uses Large Language Models directly in your pipelines.`
			`category_slug: haystack-classes`
			`title: PromptNode API`
			`slug: prompt-node-api`
			`order: 115`
			`markdown:`
			`descriptive_class_title: false`
			`descriptive_module_title: true`
			`add_method_class_prefix: true`
			`add_member_class_prefix: false`
			`filename: prompt_node_api.md`