KnowledgeBaseFlowNodeConfigurationDict¶
Dictionary Type¶
KnowledgeBaseFlowNodeConfigurationDict
¶
Bases: TypedDict
Dictionary form of KnowledgeBaseFlowNodeConfiguration.
Attributes¶
guardrail_configuration
instance-attribute
¶
guardrail_configuration: GuardrailConfiguration | GuardrailConfigurationDict | None
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
inference_configuration
instance-attribute
¶
inference_configuration: PromptInferenceConfiguration | PromptInferenceConfigurationDict | None
Contains inference configurations for the prompt.
knowledge_base_id
instance-attribute
¶
knowledge_base_id: str | None
The unique identifier of the knowledge base to query.
model_id
instance-attribute
¶
model_id: str | None
The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
number_of_results
instance-attribute
¶
number_of_results: int | None
The number of results to retrieve from the knowledge base.
orchestration_configuration
instance-attribute
¶
orchestration_configuration: KnowledgeBaseOrchestrationConfiguration | KnowledgeBaseOrchestrationConfigurationDict | None
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
prompt_template
instance-attribute
¶
prompt_template: KnowledgeBasePromptTemplate | KnowledgeBasePromptTemplateDict | None
A custom prompt template to use with the knowledge base for generating responses.
reranking_configuration
instance-attribute
¶
reranking_configuration: VectorSearchRerankingConfiguration | VectorSearchRerankingConfigurationDict | None
The configuration for reranking the retrieved results from the knowledge base to improve relevance.