@aws-sdk/client-bedrock-agent 3.1152.0 → 3.1154.0

package/dist-types/ts3.4/commands/index.d.ts

@@ -10,6 +10,8 @@ export * from "./CreateFlowVersionCommand";
 export * from "./CreateKnowledgeBaseCommand";
 export * from "./CreatePromptCommand";
 export * from "./CreatePromptVersionCommand";
+export * from "./CreateRetrievalInstructionCommand";
+export * from "./CreateRetrievalInstructionVersionCommand";
 export * from "./CreateVpcConfigurationCommand";
 export * from "./DeleteAgentActionGroupCommand";
 export * from "./DeleteAgentAliasCommand";
@@ -23,6 +25,7 @@ export * from "./DeleteKnowledgeBaseCommand";
 export * from "./DeleteKnowledgeBaseDocumentsCommand";
 export * from "./DeletePromptCommand";
 export * from "./DeleteResourcePolicyCommand";
+export * from "./DeleteRetrievalInstructionCommand";
 export * from "./DeleteVpcConfigurationCommand";
 export * from "./DisassociateAgentCollaboratorCommand";
 export * from "./DisassociateAgentKnowledgeBaseCommand";
@@ -41,6 +44,7 @@ export * from "./GetKnowledgeBaseCommand";
 export * from "./GetKnowledgeBaseDocumentsCommand";
 export * from "./GetPromptCommand";
 export * from "./GetResourcePolicyCommand";
+export * from "./GetRetrievalInstructionCommand";
 export * from "./GetVpcConfigurationCommand";
 export * from "./IngestKnowledgeBaseDocumentsCommand";
 export * from "./ListAgentActionGroupsCommand";
@@ -57,6 +61,8 @@ export * from "./ListIngestionJobsCommand";
 export * from "./ListKnowledgeBaseDocumentsCommand";
 export * from "./ListKnowledgeBasesCommand";
 export * from "./ListPromptsCommand";
+export * from "./ListRetrievalInstructionVersionsCommand";
+export * from "./ListRetrievalInstructionsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListVpcConfigurationsCommand";
 export * from "./PrepareAgentCommand";
@@ -76,4 +82,5 @@ export * from "./UpdateFlowAliasCommand";
 export * from "./UpdateFlowCommand";
 export * from "./UpdateKnowledgeBaseCommand";
 export * from "./UpdatePromptCommand";
+export * from "./UpdateRetrievalInstructionCommand";
 export * from "./ValidateFlowDefinitionCommand";

package/dist-types/ts3.4/models/enums.d.ts

@@ -523,3 +523,34 @@ export declare const KnowledgeBaseStatus: {
   readonly UPDATING: "UPDATING";
 };
 export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
+export declare const RetrievalInstructionLastTransitionStatus: {
+  readonly CREATE_FAILED: "CREATE_FAILED";
+  readonly CREATE_SUCCESSFUL: "CREATE_SUCCESSFUL";
+  readonly CREATING: "CREATING";
+  readonly UPDATE_FAILED: "UPDATE_FAILED";
+  readonly UPDATE_SUCCESSFUL: "UPDATE_SUCCESSFUL";
+  readonly UPDATING: "UPDATING";
+};
+export type RetrievalInstructionLastTransitionStatus =
+  (typeof RetrievalInstructionLastTransitionStatus)[keyof typeof RetrievalInstructionLastTransitionStatus];
+export declare const RetrievalInstructionStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly INACTIVE: "INACTIVE";
+};
+export type RetrievalInstructionStatus =
+  (typeof RetrievalInstructionStatus)[keyof typeof RetrievalInstructionStatus];
+export declare const RetrievalInstructionFailureReasonCode: {
+  readonly CLIENT_ERROR: "CLIENT_ERROR";
+  readonly CONTENT_REJECTED: "CONTENT_REJECTED";
+  readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+};
+export type RetrievalInstructionFailureReasonCode =
+  (typeof RetrievalInstructionFailureReasonCode)[keyof typeof RetrievalInstructionFailureReasonCode];
+export declare const RetrievalInstructionFieldName: {
+  readonly ANSWER_FORMAT: "ANSWER_FORMAT";
+  readonly ANSWER_POLICY: "ANSWER_POLICY";
+  readonly PERSONA: "PERSONA";
+  readonly RETRIEVAL_GUIDANCE: "RETRIEVAL_GUIDANCE";
+};
+export type RetrievalInstructionFieldName =
+  (typeof RetrievalInstructionFieldName)[keyof typeof RetrievalInstructionFieldName];

package/dist-types/ts3.4/models/models_1.d.ts

@@ -18,6 +18,10 @@ import {
   RedshiftQueryEngineStorageType,
   RedshiftQueryEngineType,
   RedshiftServerlessAuthType,
+  RetrievalInstructionFailureReasonCode,
+  RetrievalInstructionFieldName,
+  RetrievalInstructionLastTransitionStatus,
+  RetrievalInstructionStatus,
   SupplementalDataStorageLocationType,
   VpcConfigurationStatus,
   VpcProtocol,
@@ -552,6 +556,120 @@ export interface PutResourcePolicyResponse {
   resourceArn: string | undefined;
   revisionId: string | undefined;
 }
+export interface RetrievalInstructionContent {
+  retrievalGuidance?: string | undefined;
+  persona?: string | undefined;
+  answerFormat?: string | undefined;
+  answerPolicy?: string | undefined;
+}
+export interface CreateRetrievalInstructionRequest {
+  clientToken?: string | undefined;
+  name: string | undefined;
+  instruction: RetrievalInstructionContent | undefined;
+  description?: string | undefined;
+  customerEncryptionKeyArn?: string | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export interface CreateRetrievalInstructionResponse {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  name: string | undefined;
+  status: RetrievalInstructionStatus | undefined;
+  lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
+  createdAt: Date | undefined;
+  updatedAt: Date | undefined;
+}
+export interface CreateRetrievalInstructionVersionRequest {
+  retrievalInstructionId: string | undefined;
+  description?: string | undefined;
+  clientToken?: string | undefined;
+}
+export interface CreateRetrievalInstructionVersionResponse {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  version: string | undefined;
+  createdAt: Date | undefined;
+  description?: string | undefined;
+}
+export interface DeleteRetrievalInstructionRequest {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionVersion?: string | undefined;
+}
+export interface DeleteRetrievalInstructionResponse {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  version?: string | undefined;
+}
+export interface GetRetrievalInstructionRequest {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionVersion?: string | undefined;
+}
+export interface RetrievalInstructionFailureReason {
+  fieldName?: RetrievalInstructionFieldName | undefined;
+  code: RetrievalInstructionFailureReasonCode | undefined;
+  message: string | undefined;
+}
+export interface GetRetrievalInstructionResponse {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  name: string | undefined;
+  status: RetrievalInstructionStatus | undefined;
+  lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
+  instruction?: RetrievalInstructionContent | undefined;
+  createdAt: Date | undefined;
+  updatedAt: Date | undefined;
+  description?: string | undefined;
+  customerEncryptionKeyArn?: string | undefined;
+  lastTransitionStatusReasons?: RetrievalInstructionFailureReason[] | undefined;
+  version?: string | undefined;
+  latestVersion?: string | undefined;
+}
+export interface ListRetrievalInstructionsRequest {
+  status?: RetrievalInstructionStatus | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface RetrievalInstructionSummary {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  name: string | undefined;
+  status: RetrievalInstructionStatus | undefined;
+  lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
+  createdAt: Date | undefined;
+  updatedAt: Date | undefined;
+  description?: string | undefined;
+}
+export interface ListRetrievalInstructionsResponse {
+  retrievalInstructionSummaries: RetrievalInstructionSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListRetrievalInstructionVersionsRequest {
+  retrievalInstructionId: string | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface RetrievalInstructionVersionSummary {
+  version: string | undefined;
+  createdAt: Date | undefined;
+}
+export interface ListRetrievalInstructionVersionsResponse {
+  retrievalInstructionVersionSummaries: RetrievalInstructionVersionSummary[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface UpdateRetrievalInstructionRequest {
+  retrievalInstructionId: string | undefined;
+  instruction: RetrievalInstructionContent | undefined;
+  description?: string | undefined;
+}
+export interface UpdateRetrievalInstructionResponse {
+  retrievalInstructionId: string | undefined;
+  retrievalInstructionArn: string | undefined;
+  name: string | undefined;
+  status: RetrievalInstructionStatus | undefined;
+  lastTransitionStatus: RetrievalInstructionLastTransitionStatus | undefined;
+  createdAt: Date | undefined;
+  updatedAt: Date | undefined;
+}
 export interface ListTagsForResourceRequest {
   resourceArn: string | undefined;
 }

package/dist-types/ts3.4/pagination/ListRetrievalInstructionVersionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListRetrievalInstructionVersionsCommandInput,
+  ListRetrievalInstructionVersionsCommandOutput,
+} from "../commands/ListRetrievalInstructionVersionsCommand";
+import { BedrockAgentPaginationConfiguration } from "./Interfaces";
+export declare const paginateListRetrievalInstructionVersions: (
+  config: BedrockAgentPaginationConfiguration,
+  input: ListRetrievalInstructionVersionsCommandInput,
+  ...rest: any[]
+) => Paginator<ListRetrievalInstructionVersionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListRetrievalInstructionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListRetrievalInstructionsCommandInput,
+  ListRetrievalInstructionsCommandOutput,
+} from "../commands/ListRetrievalInstructionsCommand";
+import { BedrockAgentPaginationConfiguration } from "./Interfaces";
+export declare const paginateListRetrievalInstructions: (
+  config: BedrockAgentPaginationConfiguration,
+  input: ListRetrievalInstructionsCommandInput,
+  ...rest: any[]
+) => Paginator<ListRetrievalInstructionsCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -13,4 +13,6 @@ export * from "./ListIngestionJobsPaginator";
 export * from "./ListKnowledgeBaseDocumentsPaginator";
 export * from "./ListKnowledgeBasesPaginator";
 export * from "./ListPromptsPaginator";
+export * from "./ListRetrievalInstructionsPaginator";
+export * from "./ListRetrievalInstructionVersionsPaginator";
 export * from "./ListVpcConfigurationsPaginator";

package/dist-types/ts3.4/schemas/schemas_0.d.ts

@@ -74,6 +74,10 @@ export declare var CreatePromptRequest$: StaticStructureSchema;
 export declare var CreatePromptResponse$: StaticStructureSchema;
 export declare var CreatePromptVersionRequest$: StaticStructureSchema;
 export declare var CreatePromptVersionResponse$: StaticStructureSchema;
+export declare var CreateRetrievalInstructionRequest$: StaticStructureSchema;
+export declare var CreateRetrievalInstructionResponse$: StaticStructureSchema;
+export declare var CreateRetrievalInstructionVersionRequest$: StaticStructureSchema;
+export declare var CreateRetrievalInstructionVersionResponse$: StaticStructureSchema;
 export declare var CreateVpcConfigurationRequest$: StaticStructureSchema;
 export declare var CreateVpcConfigurationResponse$: StaticStructureSchema;
 export declare var CuratedQuery$: StaticStructureSchema;
@@ -111,6 +115,8 @@ export declare var DeletePromptRequest$: StaticStructureSchema;
 export declare var DeletePromptResponse$: StaticStructureSchema;
 export declare var DeleteResourcePolicyRequest$: StaticStructureSchema;
 export declare var DeleteResourcePolicyResponse$: StaticStructureSchema;
+export declare var DeleteRetrievalInstructionRequest$: StaticStructureSchema;
+export declare var DeleteRetrievalInstructionResponse$: StaticStructureSchema;
 export declare var DeleteVpcConfigurationRequest$: StaticStructureSchema;
 export declare var DeleteVpcConfigurationResponse$: StaticStructureSchema;
 export declare var DeletionProtectionConfiguration$: StaticStructureSchema;
@@ -173,6 +179,8 @@ export declare var GetPromptRequest$: StaticStructureSchema;
 export declare var GetPromptResponse$: StaticStructureSchema;
 export declare var GetResourcePolicyRequest$: StaticStructureSchema;
 export declare var GetResourcePolicyResponse$: StaticStructureSchema;
+export declare var GetRetrievalInstructionRequest$: StaticStructureSchema;
+export declare var GetRetrievalInstructionResponse$: StaticStructureSchema;
 export declare var GetVpcConfigurationRequest$: StaticStructureSchema;
 export declare var GetVpcConfigurationResponse$: StaticStructureSchema;
 export declare var GuardrailConfiguration$: StaticStructureSchema;
@@ -234,6 +242,10 @@ export declare var ListKnowledgeBasesRequest$: StaticStructureSchema;
 export declare var ListKnowledgeBasesResponse$: StaticStructureSchema;
 export declare var ListPromptsRequest$: StaticStructureSchema;
 export declare var ListPromptsResponse$: StaticStructureSchema;
+export declare var ListRetrievalInstructionsRequest$: StaticStructureSchema;
+export declare var ListRetrievalInstructionsResponse$: StaticStructureSchema;
+export declare var ListRetrievalInstructionVersionsRequest$: StaticStructureSchema;
+export declare var ListRetrievalInstructionVersionsResponse$: StaticStructureSchema;
 export declare var ListTagsForResourceRequest$: StaticStructureSchema;
 export declare var ListTagsForResourceResponse$: StaticStructureSchema;
 export declare var ListVpcConfigurationsRequest$: StaticStructureSchema;
@@ -320,6 +332,10 @@ export declare var RedshiftServerlessAuthConfiguration$: StaticStructureSchema;
 export declare var RedshiftServerlessConfiguration$: StaticStructureSchema;
 export declare var RetrievalFlowNodeConfiguration$: StaticStructureSchema;
 export declare var RetrievalFlowNodeS3Configuration$: StaticStructureSchema;
+export declare var RetrievalInstructionContent$: StaticStructureSchema;
+export declare var RetrievalInstructionFailureReason$: StaticStructureSchema;
+export declare var RetrievalInstructionSummary$: StaticStructureSchema;
+export declare var RetrievalInstructionVersionSummary$: StaticStructureSchema;
 export declare var S3Content$: StaticStructureSchema;
 export declare var S3DataSourceConfiguration$: StaticStructureSchema;
 export declare var S3Identifier$: StaticStructureSchema;
@@ -388,6 +404,8 @@ export declare var UpdateKnowledgeBaseRequest$: StaticStructureSchema;
 export declare var UpdateKnowledgeBaseResponse$: StaticStructureSchema;
 export declare var UpdatePromptRequest$: StaticStructureSchema;
 export declare var UpdatePromptResponse$: StaticStructureSchema;
+export declare var UpdateRetrievalInstructionRequest$: StaticStructureSchema;
+export declare var UpdateRetrievalInstructionResponse$: StaticStructureSchema;
 export declare var UrlConfiguration$: StaticStructureSchema;
 export declare var ValidateFlowDefinitionRequest$: StaticStructureSchema;
 export declare var ValidateFlowDefinitionResponse$: StaticStructureSchema;
@@ -440,6 +458,8 @@ export declare var CreateFlowVersion$: StaticOperationSchema;
 export declare var CreateKnowledgeBase$: StaticOperationSchema;
 export declare var CreatePrompt$: StaticOperationSchema;
 export declare var CreatePromptVersion$: StaticOperationSchema;
+export declare var CreateRetrievalInstruction$: StaticOperationSchema;
+export declare var CreateRetrievalInstructionVersion$: StaticOperationSchema;
 export declare var CreateVpcConfiguration$: StaticOperationSchema;
 export declare var DeleteAgent$: StaticOperationSchema;
 export declare var DeleteAgentActionGroup$: StaticOperationSchema;
@@ -453,6 +473,7 @@ export declare var DeleteKnowledgeBase$: StaticOperationSchema;
 export declare var DeleteKnowledgeBaseDocuments$: StaticOperationSchema;
 export declare var DeletePrompt$: StaticOperationSchema;
 export declare var DeleteResourcePolicy$: StaticOperationSchema;
+export declare var DeleteRetrievalInstruction$: StaticOperationSchema;
 export declare var DeleteVpcConfiguration$: StaticOperationSchema;
 export declare var DisassociateAgentCollaborator$: StaticOperationSchema;
 export declare var DisassociateAgentKnowledgeBase$: StaticOperationSchema;
@@ -471,6 +492,7 @@ export declare var GetKnowledgeBase$: StaticOperationSchema;
 export declare var GetKnowledgeBaseDocuments$: StaticOperationSchema;
 export declare var GetPrompt$: StaticOperationSchema;
 export declare var GetResourcePolicy$: StaticOperationSchema;
+export declare var GetRetrievalInstruction$: StaticOperationSchema;
 export declare var GetVpcConfiguration$: StaticOperationSchema;
 export declare var IngestKnowledgeBaseDocuments$: StaticOperationSchema;
 export declare var ListAgentActionGroups$: StaticOperationSchema;
@@ -487,6 +509,8 @@ export declare var ListIngestionJobs$: StaticOperationSchema;
 export declare var ListKnowledgeBaseDocuments$: StaticOperationSchema;
 export declare var ListKnowledgeBases$: StaticOperationSchema;
 export declare var ListPrompts$: StaticOperationSchema;
+export declare var ListRetrievalInstructions$: StaticOperationSchema;
+export declare var ListRetrievalInstructionVersions$: StaticOperationSchema;
 export declare var ListTagsForResource$: StaticOperationSchema;
 export declare var ListVpcConfigurations$: StaticOperationSchema;
 export declare var PrepareAgent$: StaticOperationSchema;
@@ -506,4 +530,5 @@ export declare var UpdateFlow$: StaticOperationSchema;
 export declare var UpdateFlowAlias$: StaticOperationSchema;
 export declare var UpdateKnowledgeBase$: StaticOperationSchema;
 export declare var UpdatePrompt$: StaticOperationSchema;
+export declare var UpdateRetrievalInstruction$: StaticOperationSchema;
 export declare var ValidateFlowDefinition$: StaticOperationSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/client-bedrock-agent",
-  "version": "3.1152.0",
+  "version": "3.1154.0",
   "description": "AWS SDK for JavaScript Bedrock Agent Client for Node.js, Browser and React Native",
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-bedrock-agent",
   "license": "Apache-2.0",
@@ -46,10 +46,10 @@
     "test:index": "tsc -p tsconfig.test.json && node ./test/index-objects.spec.mjs"
   },
   "dependencies": {
-    "@aws-sdk/core": "^3.978.3",
-    "@aws-sdk/credential-provider-node": "^3.972.86",
+    "@aws-sdk/core": "^3.978.4",
+    "@aws-sdk/credential-provider-node": "^3.972.87",
     "@aws-sdk/types": "^3.974.6",
-    "@smithy/core": "^3.35.2",
+    "@smithy/core": "^3.36.0",
     "@smithy/fetch-http-handler": "^5.8.0",
     "@smithy/node-http-handler": "^4.12.1",
     "@smithy/types": "^4.19.0",