@aws-sdk/client-bedrock-agent-runtime 3.940.0 → 3.943.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -258,9 +258,17 @@ declare const RetrieveAndGenerateCommand_base: {
258
258
  * // retrievedReferences: [ // RetrievedReferences
259
259
  * // { // RetrievedReference
260
260
  * // content: { // RetrievalResultContent
261
- * // type: "TEXT" || "IMAGE" || "ROW",
261
+ * // type: "TEXT" || "IMAGE" || "ROW" || "AUDIO" || "VIDEO",
262
262
  * // text: "STRING_VALUE",
263
263
  * // byteContent: "STRING_VALUE",
264
+ * // video: { // VideoSegment
265
+ * // s3Uri: "STRING_VALUE", // required
266
+ * // summary: "STRING_VALUE",
267
+ * // },
268
+ * // audio: { // AudioSegment
269
+ * // s3Uri: "STRING_VALUE", // required
270
+ * // transcription: "STRING_VALUE",
271
+ * // },
264
272
  * // row: [ // RetrievalResultContentRow
265
273
  * // { // RetrievalResultContentColumn
266
274
  * // columnName: "STRING_VALUE",
@@ -258,9 +258,17 @@ declare const RetrieveAndGenerateStreamCommand_base: {
258
258
  * // retrievedReferences: [ // RetrievedReferences
259
259
  * // { // RetrievedReference
260
260
  * // content: { // RetrievalResultContent
261
- * // type: "TEXT" || "IMAGE" || "ROW",
261
+ * // type: "TEXT" || "IMAGE" || "ROW" || "AUDIO" || "VIDEO",
262
262
  * // text: "STRING_VALUE",
263
263
  * // byteContent: "STRING_VALUE",
264
+ * // video: { // VideoSegment
265
+ * // s3Uri: "STRING_VALUE", // required
266
+ * // summary: "STRING_VALUE",
267
+ * // },
268
+ * // audio: { // AudioSegment
269
+ * // s3Uri: "STRING_VALUE", // required
270
+ * // transcription: "STRING_VALUE",
271
+ * // },
264
272
  * // row: [ // RetrievalResultContentRow
265
273
  * // { // RetrievalResultContentColumn
266
274
  * // columnName: "STRING_VALUE",
@@ -314,9 +322,17 @@ declare const RetrieveAndGenerateStreamCommand_base: {
314
322
  * // retrievedReferences: [
315
323
  * // {
316
324
  * // content: {
317
- * // type: "TEXT" || "IMAGE" || "ROW",
325
+ * // type: "TEXT" || "IMAGE" || "ROW" || "AUDIO" || "VIDEO",
318
326
  * // text: "STRING_VALUE",
319
327
  * // byteContent: "STRING_VALUE",
328
+ * // video: {
329
+ * // s3Uri: "STRING_VALUE", // required
330
+ * // summary: "STRING_VALUE",
331
+ * // },
332
+ * // audio: {
333
+ * // s3Uri: "STRING_VALUE", // required
334
+ * // transcription: "STRING_VALUE",
335
+ * // },
320
336
  * // row: [
321
337
  * // {
322
338
  * // columnName: "STRING_VALUE",
@@ -39,7 +39,12 @@ declare const RetrieveCommand_base: {
39
39
  * const input = { // RetrieveRequest
40
40
  * knowledgeBaseId: "STRING_VALUE", // required
41
41
  * retrievalQuery: { // KnowledgeBaseQuery
42
- * text: "STRING_VALUE", // required
42
+ * type: "TEXT" || "IMAGE",
43
+ * text: "STRING_VALUE",
44
+ * image: { // InputImage
45
+ * format: "png" || "jpeg" || "gif" || "webp", // required
46
+ * inlineContent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
47
+ * },
43
48
  * },
44
49
  * retrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
45
50
  * vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
@@ -148,9 +153,17 @@ declare const RetrieveCommand_base: {
148
153
  * // retrievalResults: [ // KnowledgeBaseRetrievalResults // required
149
154
  * // { // KnowledgeBaseRetrievalResult
150
155
  * // content: { // RetrievalResultContent
151
- * // type: "TEXT" || "IMAGE" || "ROW",
156
+ * // type: "TEXT" || "IMAGE" || "ROW" || "AUDIO" || "VIDEO",
152
157
  * // text: "STRING_VALUE",
153
158
  * // byteContent: "STRING_VALUE",
159
+ * // video: { // VideoSegment
160
+ * // s3Uri: "STRING_VALUE", // required
161
+ * // summary: "STRING_VALUE",
162
+ * // },
163
+ * // audio: { // AudioSegment
164
+ * // s3Uri: "STRING_VALUE", // required
165
+ * // transcription: "STRING_VALUE",
166
+ * // },
154
167
  * // row: [ // RetrievalResultContentRow
155
168
  * // { // RetrievalResultContentColumn
156
169
  * // columnName: "STRING_VALUE",
@@ -13,4 +13,5 @@ export * from "./pagination";
13
13
  export * from "./models/enums";
14
14
  export * from "./models/errors";
15
15
  export type * from "./models/models_0";
16
+ export type * from "./models/models_1";
16
17
  export { BedrockAgentRuntimeServiceException } from "./models/BedrockAgentRuntimeServiceException";
@@ -352,9 +352,11 @@ export type RetrievalResultContentColumnType = (typeof RetrievalResultContentCol
352
352
  * @enum
353
353
  */
354
354
  export declare const RetrievalResultContentType: {
355
+ readonly AUDIO: "AUDIO";
355
356
  readonly IMAGE: "IMAGE";
356
357
  readonly ROW: "ROW";
357
358
  readonly TEXT: "TEXT";
359
+ readonly VIDEO: "VIDEO";
358
360
  };
359
361
  /**
360
362
  * @public
@@ -821,6 +823,32 @@ export declare const GuadrailAction: {
821
823
  * @public
822
824
  */
823
825
  export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
826
+ /**
827
+ * @public
828
+ * @enum
829
+ */
830
+ export declare const InputImageFormat: {
831
+ readonly gif: "gif";
832
+ readonly jpeg: "jpeg";
833
+ readonly png: "png";
834
+ readonly webp: "webp";
835
+ };
836
+ /**
837
+ * @public
838
+ */
839
+ export type InputImageFormat = (typeof InputImageFormat)[keyof typeof InputImageFormat];
840
+ /**
841
+ * @public
842
+ * @enum
843
+ */
844
+ export declare const KnowledgeBaseQueryType: {
845
+ readonly IMAGE: "IMAGE";
846
+ readonly TEXT: "TEXT";
847
+ };
848
+ /**
849
+ * @public
850
+ */
851
+ export type KnowledgeBaseQueryType = (typeof KnowledgeBaseQueryType)[keyof typeof KnowledgeBaseQueryType];
824
852
  /**
825
853
  * @public
826
854
  * @enum
@@ -1,5 +1,5 @@
1
1
  import { DocumentType as __DocumentType } from "@smithy/types";
2
- import { ActionGroupSignature, ActionInvocationType, AgentCollaboration, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageFormat, ImageInputFormat, InputQueryType, InvocationType, MemoryType, NodeErrorCode, NodeType, OrchestrationType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, RetrieveAndGenerateType, SearchType, SessionStatus, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
2
+ import { ActionGroupSignature, ActionInvocationType, AgentCollaboration, AttributeType, ConfirmationState, ConversationRole, CreationMode, CustomControlMethod, ExecutionType, ExternalSourceType, FileSourceType, FileUseCase, FlowCompletionReason, FlowControlNodeType, FlowErrorCode, FlowExecutionErrorType, FlowExecutionEventType, FlowExecutionStatus, FlowNodeInputCategory, FlowNodeIODataType, GeneratedQueryType, GuadrailAction, GuardrailAction, GuardrailContentFilterConfidence, GuardrailContentFilterType, GuardrailContentPolicyAction, GuardrailManagedWordType, GuardrailPiiEntityType, GuardrailSensitiveInformationPolicyAction, GuardrailTopicPolicyAction, GuardrailTopicType, GuardrailWordPolicyAction, ImageFormat, ImageInputFormat, InputImageFormat, InputQueryType, InvocationType, KnowledgeBaseQueryType, MemoryType, NodeErrorCode, NodeType, ParameterType, PayloadType, PerformanceConfigLatency, PromptState, PromptType, QueryTransformationMode, QueryTransformationType, RelayConversationHistory, RequireConfirmation, RerankDocumentType, RerankingConfigurationType, RerankingMetadataSelectionMode, RerankQueryContentType, RerankSourceType, ResponseState, RetrievalResultContentColumnType, RetrievalResultContentType, RetrievalResultLocationType, RetrieveAndGenerateType, SearchType, SessionStatus, Source, TextToSqlConfigurationType, Type, VectorSearchRerankingConfigurationType } from "./enums";
3
3
  import { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ModelNotReadyException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
4
4
  /**
5
5
  * <p> Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. </p>
@@ -1491,6 +1491,22 @@ export interface FinalResponse {
1491
1491
  */
1492
1492
  metadata?: Metadata | undefined;
1493
1493
  }
1494
+ /**
1495
+ * <p>Contains information about an audio segment retrieved from a knowledge base, including its location and transcription.</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>audio</code> field</p> </li> </ul>
1496
+ * @public
1497
+ */
1498
+ export interface AudioSegment {
1499
+ /**
1500
+ * <p>The S3 URI where this specific audio segment is stored in the multimodal storage destination.</p>
1501
+ * @public
1502
+ */
1503
+ s3Uri: string | undefined;
1504
+ /**
1505
+ * <p>The text transcription of the audio segment content.</p>
1506
+ * @public
1507
+ */
1508
+ transcription?: string | undefined;
1509
+ }
1494
1510
  /**
1495
1511
  * <p>Contains information about a column with a cell to return in retrieval.</p>
1496
1512
  * @public
@@ -1512,6 +1528,22 @@ export interface RetrievalResultContentColumn {
1512
1528
  */
1513
1529
  type?: RetrievalResultContentColumnType | undefined;
1514
1530
  }
1531
+ /**
1532
+ * <p>Contains information about a video segment retrieved from a knowledge base, including its location and summary.</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>video</code> field</p> </li> </ul>
1533
+ * @public
1534
+ */
1535
+ export interface VideoSegment {
1536
+ /**
1537
+ * <p>The S3 URI where this specific video segment is stored in the multimodal storage destination.</p>
1538
+ * @public
1539
+ */
1540
+ s3Uri: string | undefined;
1541
+ /**
1542
+ * <p>A text summary describing the content of the video segment.</p>
1543
+ * @public
1544
+ */
1545
+ summary?: string | undefined;
1546
+ }
1515
1547
  /**
1516
1548
  * <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</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>content</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_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>content</code> field</p> </li> </ul>
1517
1549
  * @public
@@ -1532,6 +1564,16 @@ export interface RetrievalResultContent {
1532
1564
  * @public
1533
1565
  */
1534
1566
  byteContent?: string | undefined;
1567
+ /**
1568
+ * <p>Video segment information when the retrieval result contains video content.</p>
1569
+ * @public
1570
+ */
1571
+ video?: VideoSegment | undefined;
1572
+ /**
1573
+ * <p>Audio segment information when the retrieval result contains audio content.</p>
1574
+ * @public
1575
+ */
1576
+ audio?: AudioSegment | undefined;
1535
1577
  /**
1536
1578
  * <p>Specifies information about the rows with the cells to return in retrieval.</p>
1537
1579
  * @public
@@ -6473,7 +6515,7 @@ export interface RerankRequest {
6473
6515
  */
6474
6516
  export interface RerankResult {
6475
6517
  /**
6476
- * <p>The ranking of the document. The lower a number, the higher the document is ranked.</p>
6518
+ * <p>The original index of the document from the input sources array.</p>
6477
6519
  * @public
6478
6520
  */
6479
6521
  index: number | undefined;
@@ -6509,7 +6551,7 @@ export interface RerankResponse {
6509
6551
  */
6510
6552
  export interface RetrieveAndGenerateInput {
6511
6553
  /**
6512
- * <p>The query made to the knowledge base.</p>
6554
+ * <p>The query made to the knowledge base, in characters.</p>
6513
6555
  * @public
6514
6556
  */
6515
6557
  text: string | undefined;
@@ -6573,7 +6615,7 @@ export interface InferenceConfig {
6573
6615
  */
6574
6616
  export interface PromptTemplate {
6575
6617
  /**
6576
- * <p>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</p> <p>For more information, see the following resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a> </p> </li> <li> <p> <a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a> </p> </li> </ul>
6618
+ * <p>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</p> <p>For more information, see the following resources:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a> </p> </li> <li> <p> <a href="https://docs.claude.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags">Use XML tags with Anthropic Claude models</a> </p> </li> </ul>
6577
6619
  * @public
6578
6620
  */
6579
6621
  textPromptTemplate?: string | undefined;
@@ -7138,16 +7180,42 @@ export interface RetrieveAndGenerateStreamResponse {
7138
7180
  */
7139
7181
  sessionId: string | undefined;
7140
7182
  }
7183
+ /**
7184
+ * <p>Contains the image data for multimodal knowledge base queries, including format and content.</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>image</code> field</p> </li> </ul>
7185
+ * @public
7186
+ */
7187
+ export interface InputImage {
7188
+ /**
7189
+ * <p>The format of the input image. Supported formats include png, gif, jpeg, and webp.</p>
7190
+ * @public
7191
+ */
7192
+ format: InputImageFormat | undefined;
7193
+ /**
7194
+ * <p>The base64-encoded image data for inline image content. Maximum size is 5MB.</p>
7195
+ * @public
7196
+ */
7197
+ inlineContent: Uint8Array | undefined;
7198
+ }
7141
7199
  /**
7142
7200
  * <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>
7143
7201
  * @public
7144
7202
  */
7145
7203
  export interface KnowledgeBaseQuery {
7204
+ /**
7205
+ * <p>The type of query being performed.</p>
7206
+ * @public
7207
+ */
7208
+ type?: KnowledgeBaseQueryType | undefined;
7146
7209
  /**
7147
7210
  * <p>The text of the query made to the knowledge base.</p>
7148
7211
  * @public
7149
7212
  */
7150
- text: string | undefined;
7213
+ text?: string | undefined;
7214
+ /**
7215
+ * <p>An image to include in the knowledge base query for multimodal retrieval.</p>
7216
+ * @public
7217
+ */
7218
+ image?: InputImage | undefined;
7151
7219
  }
7152
7220
  /**
7153
7221
  * <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_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p> </li> </ul>
@@ -8601,118 +8669,3 @@ export interface InvokeAgentRequest {
8601
8669
  */
8602
8670
  sourceArn?: string | undefined;
8603
8671
  }
8604
- /**
8605
- * @public
8606
- */
8607
- export interface InvokeInlineAgentRequest {
8608
- /**
8609
- * <p> The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. </p>
8610
- * @public
8611
- */
8612
- customerEncryptionKeyArn?: string | undefined;
8613
- /**
8614
- * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">model identifier (ID)</a> of the model to use for orchestration by the inline agent. For example, <code>meta.llama3-1-70b-instruct-v1:0</code>. </p>
8615
- * @public
8616
- */
8617
- foundationModel: string | undefined;
8618
- /**
8619
- * <p> The instructions that tell the inline agent what it should do and how it should interact with users. </p>
8620
- * @public
8621
- */
8622
- instruction: string | undefined;
8623
- /**
8624
- * <p> The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session. </p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.</p>
8625
- * @public
8626
- */
8627
- idleSessionTTLInSeconds?: number | undefined;
8628
- /**
8629
- * <p> A list of action groups with each action group defining the action the inline agent needs to carry out. </p>
8630
- * @public
8631
- */
8632
- actionGroups?: AgentActionGroup[] | undefined;
8633
- /**
8634
- * <p> Contains information of the knowledge bases to associate with. </p>
8635
- * @public
8636
- */
8637
- knowledgeBases?: KnowledgeBase[] | undefined;
8638
- /**
8639
- * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent. </p>
8640
- * @public
8641
- */
8642
- guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
8643
- /**
8644
- * <p> Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent. </p>
8645
- * @public
8646
- */
8647
- promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
8648
- /**
8649
- * <p> Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor. </p>
8650
- * @public
8651
- */
8652
- agentCollaboration?: AgentCollaboration | undefined;
8653
- /**
8654
- * <p> Settings for an inline agent collaborator called with <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeInlineAgent.html">InvokeInlineAgent</a>. </p>
8655
- * @public
8656
- */
8657
- collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
8658
- /**
8659
- * <p>The name for the agent.</p>
8660
- * @public
8661
- */
8662
- agentName?: string | undefined;
8663
- /**
8664
- * <p> The unique identifier of the session. Use the same value across requests to continue the same conversation. </p>
8665
- * @public
8666
- */
8667
- sessionId: string | undefined;
8668
- /**
8669
- * <p> Specifies whether to end the session with the inline agent or not. </p>
8670
- * @public
8671
- */
8672
- endSession?: boolean | undefined;
8673
- /**
8674
- * <p> Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Using trace</a>. </p>
8675
- * @public
8676
- */
8677
- enableTrace?: boolean | undefined;
8678
- /**
8679
- * <p> The prompt text to send to the agent. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
8680
- * @public
8681
- */
8682
- inputText?: string | undefined;
8683
- /**
8684
- * <p> Specifies the configurations for streaming. </p> <note> <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> </note>
8685
- * @public
8686
- */
8687
- streamingConfigurations?: StreamingConfigurations | undefined;
8688
- /**
8689
- * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeInlineAgent</code> request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.</p>
8690
- * @public
8691
- */
8692
- promptCreationConfigurations?: PromptCreationConfigurations | undefined;
8693
- /**
8694
- * <p> Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
8695
- * @public
8696
- */
8697
- inlineSessionState?: InlineSessionState | undefined;
8698
- /**
8699
- * <p> List of collaborator inline agents. </p>
8700
- * @public
8701
- */
8702
- collaborators?: Collaborator[] | undefined;
8703
- /**
8704
- * <p>Model settings for the request.</p>
8705
- * @public
8706
- */
8707
- bedrockModelConfigurations?: InlineBedrockModelConfigurations | undefined;
8708
- /**
8709
- * <p>Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default. </p>
8710
- * @public
8711
- */
8712
- orchestrationType?: OrchestrationType | undefined;
8713
- /**
8714
- * <p>Contains details of the custom orchestration configured for the agent. </p>
8715
- * @public
8716
- */
8717
- customOrchestration?: CustomOrchestration | undefined;
8718
- }
@@ -0,0 +1,117 @@
1
+ import { AgentCollaboration, OrchestrationType } from "./enums";
2
+ import { AgentActionGroup, Collaborator, CollaboratorConfiguration, CustomOrchestration, GuardrailConfigurationWithArn, InlineBedrockModelConfigurations, InlineSessionState, KnowledgeBase, PromptCreationConfigurations, PromptOverrideConfiguration, StreamingConfigurations } from "./models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface InvokeInlineAgentRequest {
7
+ /**
8
+ * <p> The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. </p>
9
+ * @public
10
+ */
11
+ customerEncryptionKeyArn?: string | undefined;
12
+ /**
13
+ * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">model identifier (ID)</a> of the model to use for orchestration by the inline agent. For example, <code>meta.llama3-1-70b-instruct-v1:0</code>. </p>
14
+ * @public
15
+ */
16
+ foundationModel: string | undefined;
17
+ /**
18
+ * <p> The instructions that tell the inline agent what it should do and how it should interact with users. </p>
19
+ * @public
20
+ */
21
+ instruction: string | undefined;
22
+ /**
23
+ * <p> The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session. </p> <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.</p>
24
+ * @public
25
+ */
26
+ idleSessionTTLInSeconds?: number | undefined;
27
+ /**
28
+ * <p> A list of action groups with each action group defining the action the inline agent needs to carry out. </p>
29
+ * @public
30
+ */
31
+ actionGroups?: AgentActionGroup[] | undefined;
32
+ /**
33
+ * <p> Contains information of the knowledge bases to associate with. </p>
34
+ * @public
35
+ */
36
+ knowledgeBases?: KnowledgeBase[] | undefined;
37
+ /**
38
+ * <p> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent. </p>
39
+ * @public
40
+ */
41
+ guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
42
+ /**
43
+ * <p> Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent. </p>
44
+ * @public
45
+ */
46
+ promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
47
+ /**
48
+ * <p> Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor. </p>
49
+ * @public
50
+ */
51
+ agentCollaboration?: AgentCollaboration | undefined;
52
+ /**
53
+ * <p> Settings for an inline agent collaborator called with <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeInlineAgent.html">InvokeInlineAgent</a>. </p>
54
+ * @public
55
+ */
56
+ collaboratorConfigurations?: CollaboratorConfiguration[] | undefined;
57
+ /**
58
+ * <p>The name for the agent.</p>
59
+ * @public
60
+ */
61
+ agentName?: string | undefined;
62
+ /**
63
+ * <p> The unique identifier of the session. Use the same value across requests to continue the same conversation. </p>
64
+ * @public
65
+ */
66
+ sessionId: string | undefined;
67
+ /**
68
+ * <p> Specifies whether to end the session with the inline agent or not. </p>
69
+ * @public
70
+ */
71
+ endSession?: boolean | undefined;
72
+ /**
73
+ * <p> Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Using trace</a>. </p>
74
+ * @public
75
+ */
76
+ enableTrace?: boolean | undefined;
77
+ /**
78
+ * <p> The prompt text to send to the agent. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
79
+ * @public
80
+ */
81
+ inputText?: string | undefined;
82
+ /**
83
+ * <p> Specifies the configurations for streaming. </p> <note> <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> </note>
84
+ * @public
85
+ */
86
+ streamingConfigurations?: StreamingConfigurations | undefined;
87
+ /**
88
+ * <p>Specifies parameters that control how the service populates the agent prompt for an <code>InvokeInlineAgent</code> request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.</p>
89
+ * @public
90
+ */
91
+ promptCreationConfigurations?: PromptCreationConfigurations | undefined;
92
+ /**
93
+ * <p> Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>. </p> <note> <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p> </note>
94
+ * @public
95
+ */
96
+ inlineSessionState?: InlineSessionState | undefined;
97
+ /**
98
+ * <p> List of collaborator inline agents. </p>
99
+ * @public
100
+ */
101
+ collaborators?: Collaborator[] | undefined;
102
+ /**
103
+ * <p>Model settings for the request.</p>
104
+ * @public
105
+ */
106
+ bedrockModelConfigurations?: InlineBedrockModelConfigurations | undefined;
107
+ /**
108
+ * <p>Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default. </p>
109
+ * @public
110
+ */
111
+ orchestrationType?: OrchestrationType | undefined;
112
+ /**
113
+ * <p>Contains details of the custom orchestration configured for the agent. </p>
114
+ * @public
115
+ */
116
+ customOrchestration?: CustomOrchestration | undefined;
117
+ }
@@ -41,6 +41,7 @@ export declare var ApiParameter: StaticStructureSchema;
41
41
  export declare var ApiRequestBody: StaticStructureSchema;
42
42
  export declare var ApiResult: StaticStructureSchema;
43
43
  export declare var Attribution: StaticStructureSchema;
44
+ export declare var AudioSegment: StaticStructureSchema;
44
45
  export declare var BadGatewayException: StaticErrorSchema;
45
46
  export declare var BedrockModelConfigurations: StaticStructureSchema;
46
47
  export declare var BedrockRerankingConfiguration: StaticStructureSchema;
@@ -149,6 +150,7 @@ export declare var InlineAgentTracePart: StaticStructureSchema;
149
150
  export declare var InlineBedrockModelConfigurations: StaticStructureSchema;
150
151
  export declare var InlineSessionState: StaticStructureSchema;
151
152
  export declare var InputFile: StaticStructureSchema;
153
+ export declare var InputImage: StaticStructureSchema;
152
154
  export declare var InternalServerException: StaticErrorSchema;
153
155
  export declare var InvocationInput: StaticStructureSchema;
154
156
  export declare var InvocationStep: StaticStructureSchema;
@@ -296,6 +298,7 @@ export declare var ValidationException: StaticErrorSchema;
296
298
  export declare var VectorSearchBedrockRerankingConfiguration: StaticStructureSchema;
297
299
  export declare var VectorSearchBedrockRerankingModelConfiguration: StaticStructureSchema;
298
300
  export declare var VectorSearchRerankingConfiguration: StaticStructureSchema;
301
+ export declare var VideoSegment: StaticStructureSchema;
299
302
  export declare var __Unit: "unit";
300
303
  export declare var BedrockAgentRuntimeServiceException: StaticErrorSchema;
301
304
  export declare var AgentActionGroups: StaticListSchema;
@@ -5,10 +5,8 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../BedrockAgentRuntimeClient";
8
- import {
9
- InvokeInlineAgentRequest,
10
- InvokeInlineAgentResponse,
11
- } from "../models/models_0";
8
+ import { InvokeInlineAgentResponse } from "../models/models_0";
9
+ import { InvokeInlineAgentRequest } from "../models/models_1";
12
10
  export { __MetadataBearer };
13
11
  export { $Command };
14
12
  export interface InvokeInlineAgentCommandInput
@@ -8,4 +8,5 @@ export * from "./pagination";
8
8
  export * from "./models/enums";
9
9
  export * from "./models/errors";
10
10
  export * from "./models/models_0";
11
+ export * from "./models/models_1";
11
12
  export { BedrockAgentRuntimeServiceException } from "./models/BedrockAgentRuntimeServiceException";
@@ -192,9 +192,11 @@ export declare const RetrievalResultContentColumnType: {
192
192
  export type RetrievalResultContentColumnType =
193
193
  (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType];
194
194
  export declare const RetrievalResultContentType: {
195
+ readonly AUDIO: "AUDIO";
195
196
  readonly IMAGE: "IMAGE";
196
197
  readonly ROW: "ROW";
197
198
  readonly TEXT: "TEXT";
199
+ readonly VIDEO: "VIDEO";
198
200
  };
199
201
  export type RetrievalResultContentType =
200
202
  (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
@@ -427,6 +429,20 @@ export declare const GuadrailAction: {
427
429
  };
428
430
  export type GuadrailAction =
429
431
  (typeof GuadrailAction)[keyof typeof GuadrailAction];
432
+ export declare const InputImageFormat: {
433
+ readonly gif: "gif";
434
+ readonly jpeg: "jpeg";
435
+ readonly png: "png";
436
+ readonly webp: "webp";
437
+ };
438
+ export type InputImageFormat =
439
+ (typeof InputImageFormat)[keyof typeof InputImageFormat];
440
+ export declare const KnowledgeBaseQueryType: {
441
+ readonly IMAGE: "IMAGE";
442
+ readonly TEXT: "TEXT";
443
+ };
444
+ export type KnowledgeBaseQueryType =
445
+ (typeof KnowledgeBaseQueryType)[keyof typeof KnowledgeBaseQueryType];
430
446
  export declare const SessionStatus: {
431
447
  readonly ACTIVE: "ACTIVE";
432
448
  readonly ENDED: "ENDED";