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

package/dist-types/ts3.4/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";
 export declare class AccessDeniedException extends __BaseException {
   readonly name: "AccessDeniedException";
@@ -95,6 +96,7 @@ export interface RetrievalResultLocation {
 export interface RetrievedReference {
   content?: RetrievalResultContent;
   location?: RetrievalResultLocation;
+  metadata?: Record<string, __DocumentType>;
 }
 export interface Citation {
   generatedResponsePart?: GeneratedResponsePart;
@@ -603,41 +605,29 @@ export interface InvokeAgentResponse {
 export interface RetrieveAndGenerateInput {
   text: string | undefined;
 }
+export interface PromptTemplate {
+  textPromptTemplate?: string;
+}
+export interface GenerationConfiguration {
+  promptTemplate?: PromptTemplate;
+}
+export interface FilterAttribute {
+  key: string | undefined;
+  value: __DocumentType | undefined;
+}
 export declare const SearchType: {
   readonly HYBRID: "HYBRID";
   readonly SEMANTIC: "SEMANTIC";
 };
 export type SearchType = (typeof SearchType)[keyof typeof SearchType];
-export interface KnowledgeBaseVectorSearchConfiguration {
-  numberOfResults?: number;
-  overrideSearchType?: SearchType;
-}
-export interface KnowledgeBaseRetrievalConfiguration {
-  vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
-}
-export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
-  knowledgeBaseId: string | undefined;
-  modelArn: string | undefined;
-  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
-}
 export declare const RetrieveAndGenerateType: {
   readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
 };
 export type RetrieveAndGenerateType =
   (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
-export interface RetrieveAndGenerateConfiguration {
-  type: RetrieveAndGenerateType | undefined;
-  knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
-}
 export interface RetrieveAndGenerateSessionConfiguration {
   kmsKeyArn: string | undefined;
 }
-export interface RetrieveAndGenerateRequest {
-  sessionId?: string;
-  input: RetrieveAndGenerateInput | undefined;
-  retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
-  sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
-}
 export interface RetrieveAndGenerateOutput {
   text: string | undefined;
 }
@@ -649,21 +639,244 @@ export interface RetrieveAndGenerateResponse {
 export interface KnowledgeBaseQuery {
   text: string | undefined;
 }
-export interface RetrieveRequest {
-  knowledgeBaseId: string | undefined;
-  retrievalQuery: KnowledgeBaseQuery | undefined;
-  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
-  nextToken?: string;
-}
 export interface KnowledgeBaseRetrievalResult {
   content: RetrievalResultContent | undefined;
   location?: RetrievalResultLocation;
   score?: number;
+  metadata?: Record<string, __DocumentType>;
 }
 export interface RetrieveResponse {
   retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
   nextToken?: string;
 }
+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;
+export declare namespace RetrievalFilter {
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+  }
+  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;
+}
+export interface KnowledgeBaseVectorSearchConfiguration {
+  numberOfResults?: number;
+  overrideSearchType?: SearchType;
+  filter?: RetrievalFilter;
+}
+export interface KnowledgeBaseRetrievalConfiguration {
+  vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
+}
+export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
+  knowledgeBaseId: string | undefined;
+  modelArn: string | undefined;
+  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
+  generationConfiguration?: GenerationConfiguration;
+}
+export interface RetrieveRequest {
+  knowledgeBaseId: string | undefined;
+  retrievalQuery: KnowledgeBaseQuery | undefined;
+  retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
+  nextToken?: string;
+}
+export interface RetrieveAndGenerateConfiguration {
+  type: RetrieveAndGenerateType | undefined;
+  knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
+}
+export interface RetrieveAndGenerateRequest {
+  sessionId?: string;
+  input: RetrieveAndGenerateInput | undefined;
+  retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
+  sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
+}
 export declare const ActionGroupInvocationInputFilterSensitiveLog: (
   obj: ActionGroupInvocationInput
 ) => any;
@@ -744,8 +957,11 @@ export declare const InvokeAgentResponseFilterSensitiveLog: (
 export declare const RetrieveAndGenerateInputFilterSensitiveLog: (
   obj: RetrieveAndGenerateInput
 ) => any;
-export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (
-  obj: RetrieveAndGenerateRequest
+export declare const PromptTemplateFilterSensitiveLog: (
+  obj: PromptTemplate
+) => any;
+export declare const GenerationConfigurationFilterSensitiveLog: (
+  obj: GenerationConfiguration
 ) => any;
 export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (
   obj: RetrieveAndGenerateOutput
@@ -756,12 +972,30 @@ export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (
 export declare const KnowledgeBaseQueryFilterSensitiveLog: (
   obj: KnowledgeBaseQuery
 ) => any;
-export declare const RetrieveRequestFilterSensitiveLog: (
-  obj: RetrieveRequest
-) => any;
 export declare const KnowledgeBaseRetrievalResultFilterSensitiveLog: (
   obj: KnowledgeBaseRetrievalResult
 ) => any;
 export declare const RetrieveResponseFilterSensitiveLog: (
   obj: RetrieveResponse
 ) => any;
+export declare const RetrievalFilterFilterSensitiveLog: (
+  obj: RetrievalFilter
+) => any;
+export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (
+  obj: KnowledgeBaseVectorSearchConfiguration
+) => any;
+export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (
+  obj: KnowledgeBaseRetrievalConfiguration
+) => any;
+export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (
+  obj: KnowledgeBaseRetrieveAndGenerateConfiguration
+) => any;
+export declare const RetrieveRequestFilterSensitiveLog: (
+  obj: RetrieveRequest
+) => any;
+export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (
+  obj: RetrieveAndGenerateConfiguration
+) => any;
+export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (
+  obj: RetrieveAndGenerateRequest
+) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-bedrock-agent-runtime",
   "description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native",
-  "version": "3.540.0",
+  "version": "3.543.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",