@aws-sdk/client-bedrock-agent-runtime 3.542.0 → 3.543.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,5 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
 import { BedrockAgentRuntimeServiceException as __BaseException } from "./BedrockAgentRuntimeServiceException";
 /**
  * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
@@ -396,6 +397,11 @@ export interface RetrievedReference {
      * @public
      */
     location?: RetrievalResultLocation;
+    /**
+     * <p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>
+     * @public
+     */
+    metadata?: Record<string, __DocumentType>;
 }
 /**
  * <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p>
@@ -1449,8 +1455,7 @@ export interface RetrieveAndGenerateInput {
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
- *                </p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -1494,6 +1499,30 @@ export interface GenerationConfiguration {
      */
     promptTemplate?: PromptTemplate;
 }
+/**
+ * <p>Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+ *          <p>This data type is used in the following API operations:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export interface FilterAttribute {
+    /**
+     * <p>The name that the metadata attribute must match.</p>
+     * @public
+     */
+    key: string | undefined;
+    /**
+     * <p>The value to whcih to compare the value of the metadata attribute.</p>
+     * @public
+     */
+    value: __DocumentType | undefined;
+}
 /**
  * @public
  * @enum
@@ -1507,223 +1536,479 @@ export declare const SearchType: {
  */
 export type SearchType = (typeof SearchType)[keyof typeof SearchType];
 /**
- * <p>Configurations for how to perform the search query and return results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+ * @public
+ * @enum
+ */
+export declare const RetrieveAndGenerateType: {
+    readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
+};
+/**
+ * @public
+ */
+export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
+/**
+ * <p>Contains configuration about the session with the knowledge base.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>vectorSearchConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p>
  *             </li>
+ *          </ul>
+ * @public
+ */
+export interface RetrieveAndGenerateSessionConfiguration {
+    /**
+     * <p>The ARN of the KMS key encrypting the session.</p>
+     * @public
+     */
+    kmsKeyArn: string | undefined;
+}
+/**
+ * <p>Contains the response generated from querying the knowledge base.</p>
+ *          <p>This data type is used in the following API operations:</p>
+ *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>vectorSearchConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface KnowledgeBaseVectorSearchConfiguration {
+export interface RetrieveAndGenerateOutput {
     /**
-     * <p>The number of source chunks to retrieve.</p>
+     * <p>The response generated from querying the knowledge base.</p>
      * @public
      */
-    numberOfResults?: number;
+    text: string | undefined;
+}
+/**
+ * @public
+ */
+export interface RetrieveAndGenerateResponse {
     /**
-     * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p>
+     * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
      * @public
      */
-    overrideSearchType?: SearchType;
+    sessionId: string | undefined;
+    /**
+     * <p>Contains the response generated from querying the knowledge base.</p>
+     * @public
+     */
+    output: RetrieveAndGenerateOutput | undefined;
+    /**
+     * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
+     * @public
+     */
+    citations?: Citation[];
 }
 /**
- * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+ * <p>Contains the query made to the knowledge base.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalConfiguration</code> field</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrievalConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalQuery</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface KnowledgeBaseRetrievalConfiguration {
+export interface KnowledgeBaseQuery {
     /**
-     * <p>Contains details about how the results from the vector search should be returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+     * <p>The text of the query made to the knowledge base.</p>
      * @public
      */
-    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
+    text: string | undefined;
 }
 /**
- * <p>Contains details about the resource being queried.</p>
+ * <p>Details about a result from querying the knowledge base.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
+export interface KnowledgeBaseRetrievalResult {
     /**
-     * <p>The unique identifier of the knowledge base that is queried and the foundation model used for generation.</p>
+     * <p>Contains a chunk of text from a data source in the knowledge base.</p>
      * @public
      */
-    knowledgeBaseId: string | undefined;
+    content: RetrievalResultContent | undefined;
     /**
-     * <p>The ARN of the foundation model used to generate a response.</p>
+     * <p>Contains information about the location of the data source.</p>
      * @public
      */
-    modelArn: string | undefined;
+    location?: RetrievalResultLocation;
     /**
-     * <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
+     * <p>The level of relevance of the result to the query.</p>
      * @public
      */
-    retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
+    score?: number;
     /**
-     * <p>Contains configurations for response generation based on the knowwledge base query results.</p>
+     * <p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>
      * @public
      */
-    generationConfiguration?: GenerationConfiguration;
+    metadata?: Record<string, __DocumentType>;
 }
 /**
  * @public
- * @enum
  */
-export declare const RetrieveAndGenerateType: {
-    readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
-};
-/**
- * @public
- */
-export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
+export interface RetrieveResponse {
+    /**
+     * <p>A list of results from querying the knowledge base.</p>
+     * @public
+     */
+    retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
+    /**
+     * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
+     * @public
+     */
+    nextToken?: string;
+}
 /**
- * <p>Contains details about the resource being queried.</p>
+ * <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrieveAndGenerateConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>filter</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface RetrieveAndGenerateConfiguration {
+export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace RetrievalFilter {
     /**
-     * <p>The type of resource that is queried by the request.</p>
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object are returned.</p>
      * @public
      */
-    type: RetrieveAndGenerateType | undefined;
+    interface EqualsMember {
+        equals: FilterAttribute;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface NotEqualsMember {
+        equals?: never;
+        notEquals: FilterAttribute;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface GreaterThanMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan: FilterAttribute;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface GreaterThanOrEqualsMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals: FilterAttribute;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface LessThanMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan: FilterAttribute;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface LessThanOrEqualsMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals: FilterAttribute;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface InMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in: FilterAttribute;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object are returned.</p>
+     * @public
+     */
+    interface NotInMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn: FilterAttribute;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
+     * @public
+     */
+    interface StartsWithMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith: FilterAttribute;
+        andAll?: never;
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</p>
+     * @public
+     */
+    interface AndAllMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll: RetrievalFilter[];
+        orAll?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</p>
+     * @public
+     */
+    interface OrAllMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll: RetrievalFilter[];
+        $unknown?: never;
+    }
     /**
-     * <p>Contains details about the resource being queried.</p>
      * @public
      */
-    knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
+    interface $UnknownMember {
+        equals?: never;
+        notEquals?: never;
+        greaterThan?: never;
+        greaterThanOrEquals?: never;
+        lessThan?: never;
+        lessThanOrEquals?: never;
+        in?: never;
+        notIn?: never;
+        startsWith?: never;
+        andAll?: never;
+        orAll?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        equals: (value: FilterAttribute) => T;
+        notEquals: (value: FilterAttribute) => T;
+        greaterThan: (value: FilterAttribute) => T;
+        greaterThanOrEquals: (value: FilterAttribute) => T;
+        lessThan: (value: FilterAttribute) => T;
+        lessThanOrEquals: (value: FilterAttribute) => T;
+        in: (value: FilterAttribute) => T;
+        notIn: (value: FilterAttribute) => T;
+        startsWith: (value: FilterAttribute) => T;
+        andAll: (value: RetrievalFilter[]) => T;
+        orAll: (value: RetrievalFilter[]) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
 }
 /**
- * <p>Contains configuration about the session with the knowledge base.</p>
+ * <p>Configurations for how to perform the search query and return results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>vectorSearchConfiguration</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>vectorSearchConfiguration</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface RetrieveAndGenerateSessionConfiguration {
-    /**
-     * <p>The ARN of the KMS key encrypting the session.</p>
-     * @public
-     */
-    kmsKeyArn: string | undefined;
-}
-/**
- * @public
- */
-export interface RetrieveAndGenerateRequest {
-    /**
-     * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
-     * @public
-     */
-    sessionId?: string;
+export interface KnowledgeBaseVectorSearchConfiguration {
     /**
-     * <p>Contains the query to be made to the knowledge base.</p>
+     * <p>The number of source chunks to retrieve.</p>
      * @public
      */
-    input: RetrieveAndGenerateInput | undefined;
+    numberOfResults?: number;
     /**
-     * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+     * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p>
      * @public
      */
-    retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
+    overrideSearchType?: SearchType;
     /**
-     * <p>Contains details about the session with the knowledge base.</p>
+     * <p>Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
      * @public
      */
-    sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
+    filter?: RetrievalFilter;
 }
 /**
- * <p>Contains the response generated from querying the knowledge base.</p>
+ * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalConfiguration</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrievalConfiguration</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface RetrieveAndGenerateOutput {
+export interface KnowledgeBaseRetrievalConfiguration {
     /**
-     * <p>The response generated from querying the knowledge base.</p>
+     * <p>Contains details about how the results from the vector search should be returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
      * @public
      */
-    text: string | undefined;
+    vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
 }
 /**
+ * <p>Contains details about the resource being queried.</p>
+ *          <p>This data type is used in the following API operations:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
-export interface RetrieveAndGenerateResponse {
+export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
     /**
-     * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
+     * <p>The unique identifier of the knowledge base that is queried and the foundation model used for generation.</p>
      * @public
      */
-    sessionId: string | undefined;
+    knowledgeBaseId: string | undefined;
     /**
-     * <p>Contains the response generated from querying the knowledge base.</p>
+     * <p>The ARN of the foundation model used to generate a response.</p>
      * @public
      */
-    output: RetrieveAndGenerateOutput | undefined;
+    modelArn: string | undefined;
     /**
-     * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
+     * <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
      * @public
      */
-    citations?: Citation[];
-}
-/**
- * <p>Contains the query made to the knowledge base.</p>
- *          <p>This data type is used in the following API operations:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalQuery</code> field</p>
- *             </li>
- *          </ul>
- * @public
- */
-export interface KnowledgeBaseQuery {
+    retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
     /**
-     * <p>The text of the query made to the knowledge base.</p>
+     * <p>Contains configurations for response generation based on the knowwledge base query results.</p>
      * @public
      */
-    text: string | undefined;
+    generationConfiguration?: GenerationConfiguration;
 }
 /**
  * @public
@@ -1751,47 +2036,52 @@ export interface RetrieveRequest {
     nextToken?: string;
 }
 /**
- * <p>Details about a result from querying the knowledge base.</p>
+ * <p>Contains details about the resource being queried.</p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrieveAndGenerateConfiguration</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
-export interface KnowledgeBaseRetrievalResult {
-    /**
-     * <p>Contains a chunk of text from a data source in the knowledge base.</p>
-     * @public
-     */
-    content: RetrievalResultContent | undefined;
+export interface RetrieveAndGenerateConfiguration {
     /**
-     * <p>Contains information about the location of the data source.</p>
+     * <p>The type of resource that is queried by the request.</p>
      * @public
      */
-    location?: RetrievalResultLocation;
+    type: RetrieveAndGenerateType | undefined;
     /**
-     * <p>The level of relevance of the result to the query.</p>
+     * <p>Contains details about the resource being queried.</p>
      * @public
      */
-    score?: number;
+    knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
 }
 /**
  * @public
  */
-export interface RetrieveResponse {
+export interface RetrieveAndGenerateRequest {
     /**
-     * <p>A list of results from querying the knowledge base.</p>
+     * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p>
      * @public
      */
-    retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
+    sessionId?: string;
     /**
-     * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
+     * <p>Contains the query to be made to the knowledge base.</p>
      * @public
      */
-    nextToken?: string;
+    input: RetrieveAndGenerateInput | undefined;
+    /**
+     * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
+     * @public
+     */
+    retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
+    /**
+     * <p>Contains details about the session with the knowledge base.</p>
+     * @public
+     */
+    sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
 }
 /**
  * @internal
@@ -1932,27 +2222,39 @@ export declare const GenerationConfigurationFilterSensitiveLog: (obj: Generation
 /**
  * @internal
  */
-export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
+export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (obj: RetrieveAndGenerateOutput) => any;
 /**
  * @internal
  */
-export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
+export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (obj: RetrieveAndGenerateResponse) => any;
 /**
  * @internal
  */
-export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (obj: RetrieveAndGenerateRequest) => any;
+export declare const KnowledgeBaseQueryFilterSensitiveLog: (obj: KnowledgeBaseQuery) => any;
 /**
  * @internal
  */
-export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (obj: RetrieveAndGenerateOutput) => any;
+export declare const KnowledgeBaseRetrievalResultFilterSensitiveLog: (obj: KnowledgeBaseRetrievalResult) => any;
 /**
  * @internal
  */
-export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (obj: RetrieveAndGenerateResponse) => any;
+export declare const RetrieveResponseFilterSensitiveLog: (obj: RetrieveResponse) => any;
 /**
  * @internal
  */
-export declare const KnowledgeBaseQueryFilterSensitiveLog: (obj: KnowledgeBaseQuery) => any;
+export declare const RetrievalFilterFilterSensitiveLog: (obj: RetrievalFilter) => any;
+/**
+ * @internal
+ */
+export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
 /**
  * @internal
  */
@@ -1960,8 +2262,8 @@ export declare const RetrieveRequestFilterSensitiveLog: (obj: RetrieveRequest) =
 /**
  * @internal
  */
-export declare const KnowledgeBaseRetrievalResultFilterSensitiveLog: (obj: KnowledgeBaseRetrievalResult) => any;
+export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
 /**
  * @internal
  */
-export declare const RetrieveResponseFilterSensitiveLog: (obj: RetrieveResponse) => any;
+export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (obj: RetrieveAndGenerateRequest) => any;