Struct KnowledgeBaseFlowNodeConfiguration 

#[non_exhaustive]
pub struct KnowledgeBaseFlowNodeConfiguration {
    pub knowledge_base_id: String,
    pub model_id: Option<String>,
    pub guardrail_configuration: Option<GuardrailConfiguration>,
    pub number_of_results: Option<i32>,
    pub prompt_template: Option<KnowledgeBasePromptTemplate>,
    pub inference_configuration: Option<PromptInferenceConfiguration>,
    pub reranking_configuration: Option<VectorSearchRerankingConfiguration>,
    pub orchestration_configuration: Option<KnowledgeBaseOrchestrationConfiguration>,
}

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

knowledge_base_id: String

The unique identifier of the knowledge base to query.

model_id: Option<String>

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.

guardrail_configuration: Option<GuardrailConfiguration>

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

number_of_results: Option<i32>

The number of results to retrieve from the knowledge base.

prompt_template: Option<KnowledgeBasePromptTemplate>

A custom prompt template to use with the knowledge base for generating responses.

inference_configuration: Option<PromptInferenceConfiguration>

Contains inference configurations for the prompt.

reranking_configuration: Option<VectorSearchRerankingConfiguration>

The configuration for reranking the retrieved results from the knowledge base to improve relevance.

orchestration_configuration: Option<KnowledgeBaseOrchestrationConfiguration>

The configuration for orchestrating the retrieval and generation process in the knowledge base node.

Implementations

impl KnowledgeBaseFlowNodeConfiguration

pub fn knowledge_base_id(&self) -> &str

The unique identifier of the knowledge base to query.

pub fn model_id(&self) -> Option<&str>

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.

pub fn guardrail_configuration(&self) -> Option<&GuardrailConfiguration>

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

pub fn number_of_results(&self) -> Option<i32>

The number of results to retrieve from the knowledge base.

pub fn prompt_template(&self) -> Option<&KnowledgeBasePromptTemplate>

A custom prompt template to use with the knowledge base for generating responses.

pub fn inference_configuration(&self) -> Option<&PromptInferenceConfiguration>

Contains inference configurations for the prompt.

pub fn reranking_configuration( &self, ) -> Option<&VectorSearchRerankingConfiguration>

The configuration for reranking the retrieved results from the knowledge base to improve relevance.

pub fn orchestration_configuration( &self, ) -> Option<&KnowledgeBaseOrchestrationConfiguration>

The configuration for orchestrating the retrieval and generation process in the knowledge base node.

impl KnowledgeBaseFlowNodeConfiguration

pub fn builder() -> KnowledgeBaseFlowNodeConfigurationBuilder

Creates a new builder-style object to manufacture KnowledgeBaseFlowNodeConfiguration.

Trait Implementations

impl Clone for KnowledgeBaseFlowNodeConfiguration

fn clone(&self) -> KnowledgeBaseFlowNodeConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KnowledgeBaseFlowNodeConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KnowledgeBaseFlowNodeConfiguration

fn eq(&self, other: &KnowledgeBaseFlowNodeConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KnowledgeBaseFlowNodeConfiguration