/AWS1/CL_BDAKNOWLEDGEBASEFLO00¶
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.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_knowledgebaseid TYPE /AWS1/BDAKNOWLEDGEBASEID /AWS1/BDAKNOWLEDGEBASEID¶
The unique identifier of the knowledge base to query.
Optional arguments:¶
iv_modelid TYPE /AWS1/BDAKNOWLEDGEBASEMODELID /AWS1/BDAKNOWLEDGEBASEMODELID¶
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.
io_guardrailconfiguration TYPE REF TO /AWS1/CL_BDAGUARDRAILCONF /AWS1/CL_BDAGUARDRAILCONF¶
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
iv_numberofresults TYPE /AWS1/BDAINTEGER /AWS1/BDAINTEGER¶
The number of results to retrieve from the knowledge base.
io_prompttemplate TYPE REF TO /AWS1/CL_BDAKNOWLEDGEBASEPRT00 /AWS1/CL_BDAKNOWLEDGEBASEPRT00¶
A custom prompt template to use with the knowledge base for generating responses.
io_inferenceconfiguration TYPE REF TO /AWS1/CL_BDAPROMPTINFERENCEC00 /AWS1/CL_BDAPROMPTINFERENCEC00¶
Contains inference configurations for the prompt.
io_rerankingconfiguration TYPE REF TO /AWS1/CL_BDAVECTORSRCHRERNKC00 /AWS1/CL_BDAVECTORSRCHRERNKC00¶
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
io_orchestrationconf TYPE REF TO /AWS1/CL_BDAKNOWLEDGEBASEORC00 /AWS1/CL_BDAKNOWLEDGEBASEORC00¶
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Queryable Attributes¶
knowledgeBaseId¶
The unique identifier of the knowledge base to query.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID, with configurable default |
ASK_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID w/ exceptions if field has no val |
HAS_KNOWLEDGEBASEID() |
Determine if KNOWLEDGEBASEID has a value |
modelId¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELID() |
Getter for MODELID, with configurable default |
ASK_MODELID() |
Getter for MODELID w/ exceptions if field has no value |
HAS_MODELID() |
Determine if MODELID has a value |
guardrailConfiguration¶
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GUARDRAILCONFIGURATION() |
Getter for GUARDRAILCONFIGURATION |
numberOfResults¶
The number of results to retrieve from the knowledge base.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBEROFRESULTS() |
Getter for NUMBEROFRESULTS, with configurable default |
ASK_NUMBEROFRESULTS() |
Getter for NUMBEROFRESULTS w/ exceptions if field has no val |
HAS_NUMBEROFRESULTS() |
Determine if NUMBEROFRESULTS has a value |
promptTemplate¶
A custom prompt template to use with the knowledge base for generating responses.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROMPTTEMPLATE() |
Getter for PROMPTTEMPLATE |
inferenceConfiguration¶
Contains inference configurations for the prompt.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INFERENCECONFIGURATION() |
Getter for INFERENCECONFIGURATION |
rerankingConfiguration¶
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RERANKINGCONFIGURATION() |
Getter for RERANKINGCONFIGURATION |
orchestrationConfiguration¶
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORCHESTRATIONCONF() |
Getter for ORCHESTRATIONCONFIGURATION |