Module Values.KnowledgeBaseFlowNodeConfigurationSource

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.

Sourcetype nonrec t = {
  1. knowledgeBaseId : FlowKnowledgeBaseId.t;
    (*

    The unique identifier of the knowledge base to query.

    *)
  2. modelId : KnowledgeBaseModelIdentifier.t option;
    (*

    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.

    *)
  3. guardrailConfiguration : GuardrailConfiguration.t option;
    (*

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

    *)
  4. numberOfResults : KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger.t option;
    (*

    The number of results to retrieve from the knowledge base.

    *)
  5. promptTemplate : KnowledgeBasePromptTemplate.t option;
    (*

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

    *)
  6. inferenceConfiguration : PromptInferenceConfiguration.t option;
    (*

    Contains inference configurations for the prompt.

    *)
  7. rerankingConfiguration : VectorSearchRerankingConfiguration.t option;
    (*

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

    *)
  8. orchestrationConfiguration : KnowledgeBaseOrchestrationConfiguration.t option;
    (*

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

    *)
}
Sourceval context_ : string
Sourceval make : ?modelId:??? -> ?guardrailConfiguration:??? -> ?numberOfResults:??? -> ?promptTemplate:??? -> ?inferenceConfiguration:??? -> ?rerankingConfiguration:??? -> ?orchestrationConfiguration:??? -> knowledgeBaseId:FlowKnowledgeBaseId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger.t | `String of FlowKnowledgeBaseId.t | `Structure of (string * [> `Enum of string | `Map of ([> `String of AdditionalModelRequestFieldsKey.t ] * [> `Structure of 'a list ]) list | `String of GuardrailIdentifier.t | `Structure of (string * [> `Enum of string | `Float of Temperature.t | `Integer of MaximumLength.t | `List of [> `String of String_.t ] list | `String of KnowledgeBaseTextPrompt.t | `Structure of (string * [> `Enum of string | `Float of Temperature.t | `Integer of MaximumLength.t | `List of [> `String of String_.t ] list | `Map of ([> `String of AdditionalModelRequestFieldsKey.t ] * [> `Structure of 'b list ]) list | `String of BedrockRerankingModelArn.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of FieldForRerankingFieldNameString.t ]) list ] list ]) list ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t