@aws-sdk/client-bedrock-agent 3.687.0 → 3.691.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.
|
@@ -99,12 +99,12 @@ export interface S3Identifier {
|
|
|
99
99
|
* <p>The name of the S3 bucket.</p>
|
|
100
100
|
* @public
|
|
101
101
|
*/
|
|
102
|
-
s3BucketName?: string;
|
|
102
|
+
s3BucketName?: string | undefined;
|
|
103
103
|
/**
|
|
104
104
|
* <p>The S3 object key for the S3 resource.</p>
|
|
105
105
|
* @public
|
|
106
106
|
*/
|
|
107
|
-
s3ObjectKey?: string;
|
|
107
|
+
s3ObjectKey?: string | undefined;
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
110
|
* <p>Contains details about the OpenAPI schema for the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>. You can either include the schema directly in the <code>payload</code> field or you can upload it to an S3 bucket and specify the S3 bucket location in the <code>s3</code> field.</p>
|
|
@@ -200,7 +200,7 @@ export interface ParameterDetail {
|
|
|
200
200
|
* <p>A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.</p>
|
|
201
201
|
* @public
|
|
202
202
|
*/
|
|
203
|
-
description?: string;
|
|
203
|
+
description?: string | undefined;
|
|
204
204
|
/**
|
|
205
205
|
* <p>The data type of the parameter.</p>
|
|
206
206
|
* @public
|
|
@@ -210,7 +210,7 @@ export interface ParameterDetail {
|
|
|
210
210
|
* <p>Whether the parameter is required for the agent to complete the function for action group invocation.</p>
|
|
211
211
|
* @public
|
|
212
212
|
*/
|
|
213
|
-
required?: boolean;
|
|
213
|
+
required?: boolean | undefined;
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
216
|
* @public
|
|
@@ -266,17 +266,17 @@ export interface Function {
|
|
|
266
266
|
* <p>A description of the function and its purpose.</p>
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
description?: string;
|
|
269
|
+
description?: string | undefined;
|
|
270
270
|
/**
|
|
271
271
|
* <p>The parameters that the agent elicits from the user to fulfill the function.</p>
|
|
272
272
|
* @public
|
|
273
273
|
*/
|
|
274
|
-
parameters?: Record<string, ParameterDetail
|
|
274
|
+
parameters?: Record<string, ParameterDetail> | undefined;
|
|
275
275
|
/**
|
|
276
276
|
* <p>Contains information if user confirmation is required to invoke the function.</p>
|
|
277
277
|
* @public
|
|
278
278
|
*/
|
|
279
|
-
requireConfirmation?: RequireConfirmation;
|
|
279
|
+
requireConfirmation?: RequireConfirmation | undefined;
|
|
280
280
|
}
|
|
281
281
|
/**
|
|
282
282
|
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
|
|
@@ -372,39 +372,39 @@ export interface CreateAgentActionGroupRequest {
|
|
|
372
372
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
373
373
|
* @public
|
|
374
374
|
*/
|
|
375
|
-
clientToken?: string;
|
|
375
|
+
clientToken?: string | undefined;
|
|
376
376
|
/**
|
|
377
377
|
* <p>A description of the action group.</p>
|
|
378
378
|
* @public
|
|
379
379
|
*/
|
|
380
|
-
description?: string;
|
|
380
|
+
description?: string | undefined;
|
|
381
381
|
/**
|
|
382
382
|
* <p>To allow your agent to request the user for additional information when trying to complete a task, set this field to <code>AMAZON.UserInput</code>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
|
|
383
383
|
* <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to <code>AMAZON.CodeInterpreter</code>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
|
|
384
384
|
* <p>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
385
385
|
* @public
|
|
386
386
|
*/
|
|
387
|
-
parentActionGroupSignature?: ActionGroupSignature;
|
|
387
|
+
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
388
388
|
/**
|
|
389
389
|
* <p>The Amazon Resource Name (ARN) of 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>
|
|
390
390
|
* @public
|
|
391
391
|
*/
|
|
392
|
-
actionGroupExecutor?: ActionGroupExecutor;
|
|
392
|
+
actionGroupExecutor?: ActionGroupExecutor | undefined;
|
|
393
393
|
/**
|
|
394
394
|
* <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
|
|
395
395
|
* @public
|
|
396
396
|
*/
|
|
397
|
-
apiSchema?: APISchema;
|
|
397
|
+
apiSchema?: APISchema | undefined;
|
|
398
398
|
/**
|
|
399
399
|
* <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
400
400
|
* @public
|
|
401
401
|
*/
|
|
402
|
-
actionGroupState?: ActionGroupState;
|
|
402
|
+
actionGroupState?: ActionGroupState | undefined;
|
|
403
403
|
/**
|
|
404
404
|
* <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
405
405
|
* @public
|
|
406
406
|
*/
|
|
407
|
-
functionSchema?: FunctionSchema;
|
|
407
|
+
functionSchema?: FunctionSchema | undefined;
|
|
408
408
|
}
|
|
409
409
|
/**
|
|
410
410
|
* <p>Contains details about an action group.</p>
|
|
@@ -436,12 +436,12 @@ export interface AgentActionGroup {
|
|
|
436
436
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
437
437
|
* @public
|
|
438
438
|
*/
|
|
439
|
-
clientToken?: string;
|
|
439
|
+
clientToken?: string | undefined;
|
|
440
440
|
/**
|
|
441
441
|
* <p>The description of the action group.</p>
|
|
442
442
|
* @public
|
|
443
443
|
*/
|
|
444
|
-
description?: string;
|
|
444
|
+
description?: string | undefined;
|
|
445
445
|
/**
|
|
446
446
|
* <p>The time at which the action group was created.</p>
|
|
447
447
|
* @public
|
|
@@ -457,22 +457,22 @@ export interface AgentActionGroup {
|
|
|
457
457
|
* <p>During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
458
458
|
* @public
|
|
459
459
|
*/
|
|
460
|
-
parentActionSignature?: ActionGroupSignature;
|
|
460
|
+
parentActionSignature?: ActionGroupSignature | undefined;
|
|
461
461
|
/**
|
|
462
462
|
* <p>The Amazon Resource Name (ARN) of 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>
|
|
463
463
|
* @public
|
|
464
464
|
*/
|
|
465
|
-
actionGroupExecutor?: ActionGroupExecutor;
|
|
465
|
+
actionGroupExecutor?: ActionGroupExecutor | undefined;
|
|
466
466
|
/**
|
|
467
467
|
* <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
|
|
468
468
|
* @public
|
|
469
469
|
*/
|
|
470
|
-
apiSchema?: APISchema;
|
|
470
|
+
apiSchema?: APISchema | undefined;
|
|
471
471
|
/**
|
|
472
472
|
* <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
|
-
functionSchema?: FunctionSchema;
|
|
475
|
+
functionSchema?: FunctionSchema | undefined;
|
|
476
476
|
/**
|
|
477
477
|
* <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
478
478
|
* @public
|
|
@@ -564,7 +564,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
564
564
|
* <p>A list of objects containing fields that caused validation errors and their corresponding validation error messages.</p>
|
|
565
565
|
* @public
|
|
566
566
|
*/
|
|
567
|
-
fieldList?: ValidationExceptionField[];
|
|
567
|
+
fieldList?: ValidationExceptionField[] | undefined;
|
|
568
568
|
/**
|
|
569
569
|
* @internal
|
|
570
570
|
*/
|
|
@@ -593,7 +593,7 @@ export interface DeleteAgentActionGroupRequest {
|
|
|
593
593
|
* <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
|
|
594
594
|
* @public
|
|
595
595
|
*/
|
|
596
|
-
skipResourceInUseCheck?: boolean;
|
|
596
|
+
skipResourceInUseCheck?: boolean | undefined;
|
|
597
597
|
}
|
|
598
598
|
/**
|
|
599
599
|
* @public
|
|
@@ -648,12 +648,12 @@ export interface ListAgentActionGroupsRequest {
|
|
|
648
648
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
649
649
|
* @public
|
|
650
650
|
*/
|
|
651
|
-
maxResults?: number;
|
|
651
|
+
maxResults?: number | undefined;
|
|
652
652
|
/**
|
|
653
653
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
654
654
|
* @public
|
|
655
655
|
*/
|
|
656
|
-
nextToken?: string;
|
|
656
|
+
nextToken?: string | undefined;
|
|
657
657
|
}
|
|
658
658
|
/**
|
|
659
659
|
* <p>Contains details about an action group.</p>
|
|
@@ -681,7 +681,7 @@ export interface ActionGroupSummary {
|
|
|
681
681
|
* <p>The description of the action group.</p>
|
|
682
682
|
* @public
|
|
683
683
|
*/
|
|
684
|
-
description?: string;
|
|
684
|
+
description?: string | undefined;
|
|
685
685
|
/**
|
|
686
686
|
* <p>The time at which the action group was last updated.</p>
|
|
687
687
|
* @public
|
|
@@ -701,7 +701,7 @@ export interface ListAgentActionGroupsResponse {
|
|
|
701
701
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
702
702
|
* @public
|
|
703
703
|
*/
|
|
704
|
-
nextToken?: string;
|
|
704
|
+
nextToken?: string | undefined;
|
|
705
705
|
}
|
|
706
706
|
/**
|
|
707
707
|
* @public
|
|
@@ -731,33 +731,33 @@ export interface UpdateAgentActionGroupRequest {
|
|
|
731
731
|
* <p>Specifies a new name for the action group.</p>
|
|
732
732
|
* @public
|
|
733
733
|
*/
|
|
734
|
-
description?: string;
|
|
734
|
+
description?: string | undefined;
|
|
735
735
|
/**
|
|
736
736
|
* <p>To allow your agent to request the user for additional information when trying to complete a task, set this field to <code>AMAZON.UserInput</code>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group.</p>
|
|
737
737
|
* <p>During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
738
738
|
* @public
|
|
739
739
|
*/
|
|
740
|
-
parentActionGroupSignature?: ActionGroupSignature;
|
|
740
|
+
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
741
741
|
/**
|
|
742
742
|
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
743
743
|
* @public
|
|
744
744
|
*/
|
|
745
|
-
actionGroupExecutor?: ActionGroupExecutor;
|
|
745
|
+
actionGroupExecutor?: ActionGroupExecutor | undefined;
|
|
746
746
|
/**
|
|
747
747
|
* <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
748
748
|
* @public
|
|
749
749
|
*/
|
|
750
|
-
actionGroupState?: ActionGroupState;
|
|
750
|
+
actionGroupState?: ActionGroupState | undefined;
|
|
751
751
|
/**
|
|
752
752
|
* <p>Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html">Action group OpenAPI schemas</a>.</p>
|
|
753
753
|
* @public
|
|
754
754
|
*/
|
|
755
|
-
apiSchema?: APISchema;
|
|
755
|
+
apiSchema?: APISchema | undefined;
|
|
756
756
|
/**
|
|
757
757
|
* <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
|
|
758
758
|
* @public
|
|
759
759
|
*/
|
|
760
|
-
functionSchema?: FunctionSchema;
|
|
760
|
+
functionSchema?: FunctionSchema | undefined;
|
|
761
761
|
}
|
|
762
762
|
/**
|
|
763
763
|
* @public
|
|
@@ -796,12 +796,12 @@ export interface GuardrailConfiguration {
|
|
|
796
796
|
* <p>The unique identifier of the guardrail.</p>
|
|
797
797
|
* @public
|
|
798
798
|
*/
|
|
799
|
-
guardrailIdentifier?: string;
|
|
799
|
+
guardrailIdentifier?: string | undefined;
|
|
800
800
|
/**
|
|
801
801
|
* <p>The version of the guardrail.</p>
|
|
802
802
|
* @public
|
|
803
803
|
*/
|
|
804
|
-
guardrailVersion?: string;
|
|
804
|
+
guardrailVersion?: string | undefined;
|
|
805
805
|
}
|
|
806
806
|
/**
|
|
807
807
|
* @public
|
|
@@ -828,7 +828,7 @@ export interface MemoryConfiguration {
|
|
|
828
828
|
* <p>The number of days the agent is configured to retain the conversational context.</p>
|
|
829
829
|
* @public
|
|
830
830
|
*/
|
|
831
|
-
storageDays?: number;
|
|
831
|
+
storageDays?: number | undefined;
|
|
832
832
|
}
|
|
833
833
|
/**
|
|
834
834
|
* <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
@@ -839,27 +839,27 @@ export interface InferenceConfiguration {
|
|
|
839
839
|
* <p>The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.</p>
|
|
840
840
|
* @public
|
|
841
841
|
*/
|
|
842
|
-
temperature?: number;
|
|
842
|
+
temperature?: number | undefined;
|
|
843
843
|
/**
|
|
844
844
|
* <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
|
|
845
845
|
* @public
|
|
846
846
|
*/
|
|
847
|
-
topP?: number;
|
|
847
|
+
topP?: number | undefined;
|
|
848
848
|
/**
|
|
849
849
|
* <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>topK</code> is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topK</code> to 50, the model selects the next token from among the top 50 most likely choices.</p>
|
|
850
850
|
* @public
|
|
851
851
|
*/
|
|
852
|
-
topK?: number;
|
|
852
|
+
topK?: number | undefined;
|
|
853
853
|
/**
|
|
854
854
|
* <p>The maximum number of tokens to allow in the generated response.</p>
|
|
855
855
|
* @public
|
|
856
856
|
*/
|
|
857
|
-
maximumLength?: number;
|
|
857
|
+
maximumLength?: number | undefined;
|
|
858
858
|
/**
|
|
859
859
|
* <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.</p>
|
|
860
860
|
* @public
|
|
861
861
|
*/
|
|
862
|
-
stopSequences?: string[];
|
|
862
|
+
stopSequences?: string[] | undefined;
|
|
863
863
|
}
|
|
864
864
|
/**
|
|
865
865
|
* @public
|
|
@@ -908,12 +908,12 @@ export interface PromptConfiguration {
|
|
|
908
908
|
* <p>The step in the agent sequence that this prompt configuration applies to.</p>
|
|
909
909
|
* @public
|
|
910
910
|
*/
|
|
911
|
-
promptType?: PromptType;
|
|
911
|
+
promptType?: PromptType | undefined;
|
|
912
912
|
/**
|
|
913
913
|
* <p>Specifies whether to override the default prompt template for this <code>promptType</code>. Set this value to <code>OVERRIDDEN</code> to use the prompt that you provide in the <code>basePromptTemplate</code>. If you leave it as <code>DEFAULT</code>, the agent uses a default prompt template.</p>
|
|
914
914
|
* @public
|
|
915
915
|
*/
|
|
916
|
-
promptCreationMode?: CreationMode;
|
|
916
|
+
promptCreationMode?: CreationMode | undefined;
|
|
917
917
|
/**
|
|
918
918
|
* <p>Specifies whether to allow the agent to carry out the step specified in the <code>promptType</code>. If you set this value to <code>DISABLED</code>, the agent skips that step. The default state for each <code>promptType</code> is as follows.</p>
|
|
919
919
|
* <ul>
|
|
@@ -940,22 +940,22 @@ export interface PromptConfiguration {
|
|
|
940
940
|
* </ul>
|
|
941
941
|
* @public
|
|
942
942
|
*/
|
|
943
|
-
promptState?: PromptState;
|
|
943
|
+
promptState?: PromptState | undefined;
|
|
944
944
|
/**
|
|
945
945
|
* <p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html">Configure the prompt templates</a>.</p>
|
|
946
946
|
* @public
|
|
947
947
|
*/
|
|
948
|
-
basePromptTemplate?: string;
|
|
948
|
+
basePromptTemplate?: string | undefined;
|
|
949
949
|
/**
|
|
950
950
|
* <p>Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the <code>promptType</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
951
951
|
* @public
|
|
952
952
|
*/
|
|
953
|
-
inferenceConfiguration?: InferenceConfiguration;
|
|
953
|
+
inferenceConfiguration?: InferenceConfiguration | undefined;
|
|
954
954
|
/**
|
|
955
955
|
* <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>. If you set the field as <code>OVERRIDEN</code>, the <code>overrideLambda</code> field in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> must be specified with the ARN of a Lambda function.</p>
|
|
956
956
|
* @public
|
|
957
957
|
*/
|
|
958
|
-
parserMode?: CreationMode;
|
|
958
|
+
parserMode?: CreationMode | undefined;
|
|
959
959
|
}
|
|
960
960
|
/**
|
|
961
961
|
* <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
@@ -971,7 +971,7 @@ export interface PromptOverrideConfiguration {
|
|
|
971
971
|
* <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <code>promptConfigurations</code> must contain a <code>parserMode</code> value that is set to <code>OVERRIDDEN</code>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>.</p>
|
|
972
972
|
* @public
|
|
973
973
|
*/
|
|
974
|
-
overrideLambda?: string;
|
|
974
|
+
overrideLambda?: string | undefined;
|
|
975
975
|
}
|
|
976
976
|
/**
|
|
977
977
|
* <p>Contains details about an agent.</p>
|
|
@@ -1003,12 +1003,12 @@ export interface Agent {
|
|
|
1003
1003
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1004
1004
|
* @public
|
|
1005
1005
|
*/
|
|
1006
|
-
clientToken?: string;
|
|
1006
|
+
clientToken?: string | undefined;
|
|
1007
1007
|
/**
|
|
1008
1008
|
* <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
|
|
1009
1009
|
* @public
|
|
1010
1010
|
*/
|
|
1011
|
-
instruction?: string;
|
|
1011
|
+
instruction?: string | undefined;
|
|
1012
1012
|
/**
|
|
1013
1013
|
* <p>The status of the agent and whether it is ready for use. The following statuses are possible:</p>
|
|
1014
1014
|
* <ul>
|
|
@@ -1041,12 +1041,12 @@ export interface Agent {
|
|
|
1041
1041
|
* <p>The foundation model used for orchestration by the agent.</p>
|
|
1042
1042
|
* @public
|
|
1043
1043
|
*/
|
|
1044
|
-
foundationModel?: string;
|
|
1044
|
+
foundationModel?: string | undefined;
|
|
1045
1045
|
/**
|
|
1046
1046
|
* <p>The description of the agent.</p>
|
|
1047
1047
|
* @public
|
|
1048
1048
|
*/
|
|
1049
|
-
description?: string;
|
|
1049
|
+
description?: string | undefined;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
1052
1052
|
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
@@ -1062,7 +1062,7 @@ export interface Agent {
|
|
|
1062
1062
|
* <p>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.</p>
|
|
1063
1063
|
* @public
|
|
1064
1064
|
*/
|
|
1065
|
-
customerEncryptionKeyArn?: string;
|
|
1065
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
1066
1066
|
/**
|
|
1067
1067
|
* <p>The time at which the agent was created.</p>
|
|
1068
1068
|
* @public
|
|
@@ -1077,32 +1077,32 @@ export interface Agent {
|
|
|
1077
1077
|
* <p>The time at which the agent was last prepared.</p>
|
|
1078
1078
|
* @public
|
|
1079
1079
|
*/
|
|
1080
|
-
preparedAt?: Date;
|
|
1080
|
+
preparedAt?: Date | undefined;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* <p>Contains reasons that the agent-related API that you invoked failed.</p>
|
|
1083
1083
|
* @public
|
|
1084
1084
|
*/
|
|
1085
|
-
failureReasons?: string[];
|
|
1085
|
+
failureReasons?: string[] | undefined;
|
|
1086
1086
|
/**
|
|
1087
1087
|
* <p>Contains recommended actions to take for the agent-related API that you invoked to succeed.</p>
|
|
1088
1088
|
* @public
|
|
1089
1089
|
*/
|
|
1090
|
-
recommendedActions?: string[];
|
|
1090
|
+
recommendedActions?: string[] | undefined;
|
|
1091
1091
|
/**
|
|
1092
1092
|
* <p>Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
1093
1093
|
* @public
|
|
1094
1094
|
*/
|
|
1095
|
-
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1095
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
1096
1096
|
/**
|
|
1097
1097
|
* <p>Details about the guardrail associated with the agent.</p>
|
|
1098
1098
|
* @public
|
|
1099
1099
|
*/
|
|
1100
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1100
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1101
1101
|
/**
|
|
1102
1102
|
* <p>Contains memory configuration for the agent.</p>
|
|
1103
1103
|
* @public
|
|
1104
1104
|
*/
|
|
1105
|
-
memoryConfiguration?: MemoryConfiguration;
|
|
1105
|
+
memoryConfiguration?: MemoryConfiguration | undefined;
|
|
1106
1106
|
}
|
|
1107
1107
|
/**
|
|
1108
1108
|
* <p>Contains details about the routing configuration of the alias.</p>
|
|
@@ -1113,12 +1113,12 @@ export interface AgentAliasRoutingConfigurationListItem {
|
|
|
1113
1113
|
* <p>The version of the agent with which the alias is associated.</p>
|
|
1114
1114
|
* @public
|
|
1115
1115
|
*/
|
|
1116
|
-
agentVersion?: string;
|
|
1116
|
+
agentVersion?: string | undefined;
|
|
1117
1117
|
/**
|
|
1118
1118
|
* <p>Information on the Provisioned Throughput assigned to an agent alias.</p>
|
|
1119
1119
|
* @public
|
|
1120
1120
|
*/
|
|
1121
|
-
provisionedThroughput?: string;
|
|
1121
|
+
provisionedThroughput?: string | undefined;
|
|
1122
1122
|
}
|
|
1123
1123
|
/**
|
|
1124
1124
|
* <p>Contains details about the history of the alias.</p>
|
|
@@ -1129,17 +1129,17 @@ export interface AgentAliasHistoryEvent {
|
|
|
1129
1129
|
* <p>Contains details about the version of the agent with which the alias is associated.</p>
|
|
1130
1130
|
* @public
|
|
1131
1131
|
*/
|
|
1132
|
-
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
1132
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
1133
1133
|
/**
|
|
1134
1134
|
* <p>The date that the alias stopped being associated to the version in the <code>routingConfiguration</code> object</p>
|
|
1135
1135
|
* @public
|
|
1136
1136
|
*/
|
|
1137
|
-
endDate?: Date;
|
|
1137
|
+
endDate?: Date | undefined;
|
|
1138
1138
|
/**
|
|
1139
1139
|
* <p>The date that the alias began being associated to the version in the <code>routingConfiguration</code> object.</p>
|
|
1140
1140
|
* @public
|
|
1141
1141
|
*/
|
|
1142
|
-
startDate?: Date;
|
|
1142
|
+
startDate?: Date | undefined;
|
|
1143
1143
|
}
|
|
1144
1144
|
/**
|
|
1145
1145
|
* @public
|
|
@@ -1186,12 +1186,12 @@ export interface AgentAlias {
|
|
|
1186
1186
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1187
1187
|
* @public
|
|
1188
1188
|
*/
|
|
1189
|
-
clientToken?: string;
|
|
1189
|
+
clientToken?: string | undefined;
|
|
1190
1190
|
/**
|
|
1191
1191
|
* <p>The description of the alias of the agent.</p>
|
|
1192
1192
|
* @public
|
|
1193
1193
|
*/
|
|
1194
|
-
description?: string;
|
|
1194
|
+
description?: string | undefined;
|
|
1195
1195
|
/**
|
|
1196
1196
|
* <p>Contains details about the routing configuration of the alias.</p>
|
|
1197
1197
|
* @public
|
|
@@ -1211,7 +1211,7 @@ export interface AgentAlias {
|
|
|
1211
1211
|
* <p>Contains details about the history of the alias.</p>
|
|
1212
1212
|
* @public
|
|
1213
1213
|
*/
|
|
1214
|
-
agentAliasHistoryEvents?: AgentAliasHistoryEvent[];
|
|
1214
|
+
agentAliasHistoryEvents?: AgentAliasHistoryEvent[] | undefined;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* <p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p>
|
|
1217
1217
|
* <ul>
|
|
@@ -1238,7 +1238,7 @@ export interface AgentAlias {
|
|
|
1238
1238
|
* <p>Information on the failure of Provisioned Throughput assigned to an agent alias.</p>
|
|
1239
1239
|
* @public
|
|
1240
1240
|
*/
|
|
1241
|
-
failureReasons?: string[];
|
|
1241
|
+
failureReasons?: string[] | undefined;
|
|
1242
1242
|
}
|
|
1243
1243
|
/**
|
|
1244
1244
|
* <p>Contains details about an alias of an agent.</p>
|
|
@@ -1259,12 +1259,12 @@ export interface AgentAliasSummary {
|
|
|
1259
1259
|
* <p>The description of the alias.</p>
|
|
1260
1260
|
* @public
|
|
1261
1261
|
*/
|
|
1262
|
-
description?: string;
|
|
1262
|
+
description?: string | undefined;
|
|
1263
1263
|
/**
|
|
1264
1264
|
* <p>Contains details about the version of the agent with which the alias is associated.</p>
|
|
1265
1265
|
* @public
|
|
1266
1266
|
*/
|
|
1267
|
-
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
1267
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
1268
1268
|
/**
|
|
1269
1269
|
* <p>The status of the alias.</p>
|
|
1270
1270
|
* @public
|
|
@@ -1359,7 +1359,7 @@ export interface AgentKnowledgeBaseSummary {
|
|
|
1359
1359
|
* <p>The description of the knowledge base associated with an agent.</p>
|
|
1360
1360
|
* @public
|
|
1361
1361
|
*/
|
|
1362
|
-
description?: string;
|
|
1362
|
+
description?: string | undefined;
|
|
1363
1363
|
/**
|
|
1364
1364
|
* <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
1365
1365
|
* @public
|
|
@@ -1385,12 +1385,12 @@ export interface CreateAgentRequest {
|
|
|
1385
1385
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1386
1386
|
* @public
|
|
1387
1387
|
*/
|
|
1388
|
-
clientToken?: string;
|
|
1388
|
+
clientToken?: string | undefined;
|
|
1389
1389
|
/**
|
|
1390
1390
|
* <p>Instructions that tell the agent what it should do and how it should interact with users.</p>
|
|
1391
1391
|
* @public
|
|
1392
1392
|
*/
|
|
1393
|
-
instruction?: string;
|
|
1393
|
+
instruction?: string | undefined;
|
|
1394
1394
|
/**
|
|
1395
1395
|
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p>
|
|
1396
1396
|
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
@@ -1413,48 +1413,48 @@ export interface CreateAgentRequest {
|
|
|
1413
1413
|
* </ul>
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
|
-
foundationModel?: string;
|
|
1416
|
+
foundationModel?: string | undefined;
|
|
1417
1417
|
/**
|
|
1418
1418
|
* <p>A description of the agent.</p>
|
|
1419
1419
|
* @public
|
|
1420
1420
|
*/
|
|
1421
|
-
description?: string;
|
|
1421
|
+
description?: string | undefined;
|
|
1422
1422
|
/**
|
|
1423
1423
|
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
1424
1424
|
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
|
-
idleSessionTTLInSeconds?: number;
|
|
1427
|
+
idleSessionTTLInSeconds?: number | undefined;
|
|
1428
1428
|
/**
|
|
1429
1429
|
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
1430
1430
|
* @public
|
|
1431
1431
|
*/
|
|
1432
|
-
agentResourceRoleArn?: string;
|
|
1432
|
+
agentResourceRoleArn?: string | undefined;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
customerEncryptionKeyArn?: string;
|
|
1437
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* <p>Any tags that you want to attach to the agent.</p>
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
|
-
tags?: Record<string, string
|
|
1442
|
+
tags?: Record<string, string> | undefined;
|
|
1443
1443
|
/**
|
|
1444
1444
|
* <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
1445
1445
|
* @public
|
|
1446
1446
|
*/
|
|
1447
|
-
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1447
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
1448
1448
|
/**
|
|
1449
1449
|
* <p>The unique Guardrail configuration assigned to the agent when it is created.</p>
|
|
1450
1450
|
* @public
|
|
1451
1451
|
*/
|
|
1452
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1452
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1453
1453
|
/**
|
|
1454
1454
|
* <p> Contains the details of the memory configured for the agent.</p>
|
|
1455
1455
|
* @public
|
|
1456
1456
|
*/
|
|
1457
|
-
memoryConfiguration?: MemoryConfiguration;
|
|
1457
|
+
memoryConfiguration?: MemoryConfiguration | undefined;
|
|
1458
1458
|
}
|
|
1459
1459
|
/**
|
|
1460
1460
|
* @public
|
|
@@ -1479,7 +1479,7 @@ export interface DeleteAgentRequest {
|
|
|
1479
1479
|
* <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
|
|
1480
1480
|
* @public
|
|
1481
1481
|
*/
|
|
1482
|
-
skipResourceInUseCheck?: boolean;
|
|
1482
|
+
skipResourceInUseCheck?: boolean | undefined;
|
|
1483
1483
|
}
|
|
1484
1484
|
/**
|
|
1485
1485
|
* @public
|
|
@@ -1524,12 +1524,12 @@ export interface ListAgentsRequest {
|
|
|
1524
1524
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
1525
1525
|
* @public
|
|
1526
1526
|
*/
|
|
1527
|
-
maxResults?: number;
|
|
1527
|
+
maxResults?: number | undefined;
|
|
1528
1528
|
/**
|
|
1529
1529
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
1530
1530
|
* @public
|
|
1531
1531
|
*/
|
|
1532
|
-
nextToken?: string;
|
|
1532
|
+
nextToken?: string | undefined;
|
|
1533
1533
|
}
|
|
1534
1534
|
/**
|
|
1535
1535
|
* <p>Contains details about an agent.</p>
|
|
@@ -1555,7 +1555,7 @@ export interface AgentSummary {
|
|
|
1555
1555
|
* <p>The description of the agent.</p>
|
|
1556
1556
|
* @public
|
|
1557
1557
|
*/
|
|
1558
|
-
description?: string;
|
|
1558
|
+
description?: string | undefined;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* <p>The time at which the agent was last updated.</p>
|
|
1561
1561
|
* @public
|
|
@@ -1565,12 +1565,12 @@ export interface AgentSummary {
|
|
|
1565
1565
|
* <p>The latest version of the agent.</p>
|
|
1566
1566
|
* @public
|
|
1567
1567
|
*/
|
|
1568
|
-
latestAgentVersion?: string;
|
|
1568
|
+
latestAgentVersion?: string | undefined;
|
|
1569
1569
|
/**
|
|
1570
1570
|
* <p>Details about the guardrail associated with the agent.</p>
|
|
1571
1571
|
* @public
|
|
1572
1572
|
*/
|
|
1573
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1573
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1574
1574
|
}
|
|
1575
1575
|
/**
|
|
1576
1576
|
* @public
|
|
@@ -1585,7 +1585,7 @@ export interface ListAgentsResponse {
|
|
|
1585
1585
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
1586
1586
|
* @public
|
|
1587
1587
|
*/
|
|
1588
|
-
nextToken?: string;
|
|
1588
|
+
nextToken?: string | undefined;
|
|
1589
1589
|
}
|
|
1590
1590
|
/**
|
|
1591
1591
|
* @public
|
|
@@ -1640,7 +1640,7 @@ export interface UpdateAgentRequest {
|
|
|
1640
1640
|
* <p>Specifies new instructions that tell the agent what it should do and how it should interact with users.</p>
|
|
1641
1641
|
* @public
|
|
1642
1642
|
*/
|
|
1643
|
-
instruction?: string;
|
|
1643
|
+
instruction?: string | undefined;
|
|
1644
1644
|
/**
|
|
1645
1645
|
* <p>The identifier for the model that you want to be used for orchestration by the agent you create.</p>
|
|
1646
1646
|
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
@@ -1668,13 +1668,13 @@ export interface UpdateAgentRequest {
|
|
|
1668
1668
|
* <p>Specifies a new description of the agent.</p>
|
|
1669
1669
|
* @public
|
|
1670
1670
|
*/
|
|
1671
|
-
description?: string;
|
|
1671
|
+
description?: string | undefined;
|
|
1672
1672
|
/**
|
|
1673
1673
|
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
1674
1674
|
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
1675
1675
|
* @public
|
|
1676
1676
|
*/
|
|
1677
|
-
idleSessionTTLInSeconds?: number;
|
|
1677
|
+
idleSessionTTLInSeconds?: number | undefined;
|
|
1678
1678
|
/**
|
|
1679
1679
|
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>
|
|
1680
1680
|
* @public
|
|
@@ -1684,22 +1684,22 @@ export interface UpdateAgentRequest {
|
|
|
1684
1684
|
* <p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.</p>
|
|
1685
1685
|
* @public
|
|
1686
1686
|
*/
|
|
1687
|
-
customerEncryptionKeyArn?: string;
|
|
1687
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
1688
1688
|
/**
|
|
1689
1689
|
* <p>Contains configurations to override prompts in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
1690
1690
|
* @public
|
|
1691
1691
|
*/
|
|
1692
|
-
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1692
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
1693
1693
|
/**
|
|
1694
1694
|
* <p>The unique Guardrail configuration assigned to the agent when it is updated.</p>
|
|
1695
1695
|
* @public
|
|
1696
1696
|
*/
|
|
1697
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1697
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1698
1698
|
/**
|
|
1699
1699
|
* <p>Specifies the new memory configuration for the agent. </p>
|
|
1700
1700
|
* @public
|
|
1701
1701
|
*/
|
|
1702
|
-
memoryConfiguration?: MemoryConfiguration;
|
|
1702
|
+
memoryConfiguration?: MemoryConfiguration | undefined;
|
|
1703
1703
|
}
|
|
1704
1704
|
/**
|
|
1705
1705
|
* @public
|
|
@@ -1740,7 +1740,7 @@ export interface AgentVersion {
|
|
|
1740
1740
|
* <p>The instructions provided to the agent.</p>
|
|
1741
1741
|
* @public
|
|
1742
1742
|
*/
|
|
1743
|
-
instruction?: string;
|
|
1743
|
+
instruction?: string | undefined;
|
|
1744
1744
|
/**
|
|
1745
1745
|
* <p>The status of the agent that the version belongs to.</p>
|
|
1746
1746
|
* @public
|
|
@@ -1750,12 +1750,12 @@ export interface AgentVersion {
|
|
|
1750
1750
|
* <p>The foundation model that the version invokes.</p>
|
|
1751
1751
|
* @public
|
|
1752
1752
|
*/
|
|
1753
|
-
foundationModel?: string;
|
|
1753
|
+
foundationModel?: string | undefined;
|
|
1754
1754
|
/**
|
|
1755
1755
|
* <p>The description of the version.</p>
|
|
1756
1756
|
* @public
|
|
1757
1757
|
*/
|
|
1758
|
-
description?: string;
|
|
1758
|
+
description?: string | undefined;
|
|
1759
1759
|
/**
|
|
1760
1760
|
* <p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p>
|
|
1761
1761
|
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.</p>
|
|
@@ -1771,7 +1771,7 @@ export interface AgentVersion {
|
|
|
1771
1771
|
* <p>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.</p>
|
|
1772
1772
|
* @public
|
|
1773
1773
|
*/
|
|
1774
|
-
customerEncryptionKeyArn?: string;
|
|
1774
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
1775
1775
|
/**
|
|
1776
1776
|
* <p>The time at which the version was created.</p>
|
|
1777
1777
|
* @public
|
|
@@ -1786,29 +1786,29 @@ export interface AgentVersion {
|
|
|
1786
1786
|
* <p>A list of reasons that the API operation on the version failed.</p>
|
|
1787
1787
|
* @public
|
|
1788
1788
|
*/
|
|
1789
|
-
failureReasons?: string[];
|
|
1789
|
+
failureReasons?: string[] | undefined;
|
|
1790
1790
|
/**
|
|
1791
1791
|
* <p>A list of recommended actions to take for the failed API operation on the version to succeed.</p>
|
|
1792
1792
|
* @public
|
|
1793
1793
|
*/
|
|
1794
|
-
recommendedActions?: string[];
|
|
1794
|
+
recommendedActions?: string[] | undefined;
|
|
1795
1795
|
/**
|
|
1796
1796
|
* <p>Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
1797
1797
|
* @public
|
|
1798
1798
|
*/
|
|
1799
|
-
promptOverrideConfiguration?: PromptOverrideConfiguration;
|
|
1799
|
+
promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
|
|
1800
1800
|
/**
|
|
1801
1801
|
* <p>Details about the guardrail associated with the agent.</p>
|
|
1802
1802
|
* @public
|
|
1803
1803
|
*/
|
|
1804
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1804
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1805
1805
|
/**
|
|
1806
1806
|
* <p>
|
|
1807
1807
|
* Contains details of the memory configuration on the version of the agent.
|
|
1808
1808
|
* </p>
|
|
1809
1809
|
* @public
|
|
1810
1810
|
*/
|
|
1811
|
-
memoryConfiguration?: MemoryConfiguration;
|
|
1811
|
+
memoryConfiguration?: MemoryConfiguration | undefined;
|
|
1812
1812
|
}
|
|
1813
1813
|
/**
|
|
1814
1814
|
* <p>Contains details about a version of an agent.</p>
|
|
@@ -1844,12 +1844,12 @@ export interface AgentVersionSummary {
|
|
|
1844
1844
|
* <p>The description of the version of the agent.</p>
|
|
1845
1845
|
* @public
|
|
1846
1846
|
*/
|
|
1847
|
-
description?: string;
|
|
1847
|
+
description?: string | undefined;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* <p>Details about the guardrail associated with the agent.</p>
|
|
1850
1850
|
* @public
|
|
1851
1851
|
*/
|
|
1852
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
1852
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
1853
1853
|
}
|
|
1854
1854
|
/**
|
|
1855
1855
|
* @public
|
|
@@ -1870,22 +1870,22 @@ export interface CreateAgentAliasRequest {
|
|
|
1870
1870
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
1871
1871
|
* @public
|
|
1872
1872
|
*/
|
|
1873
|
-
clientToken?: string;
|
|
1873
|
+
clientToken?: string | undefined;
|
|
1874
1874
|
/**
|
|
1875
1875
|
* <p>A description of the alias of the agent.</p>
|
|
1876
1876
|
* @public
|
|
1877
1877
|
*/
|
|
1878
|
-
description?: string;
|
|
1878
|
+
description?: string | undefined;
|
|
1879
1879
|
/**
|
|
1880
1880
|
* <p>Contains details about the routing configuration of the alias.</p>
|
|
1881
1881
|
* @public
|
|
1882
1882
|
*/
|
|
1883
|
-
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
1883
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
1884
1884
|
/**
|
|
1885
1885
|
* <p>Any tags that you want to attach to the alias of the agent.</p>
|
|
1886
1886
|
* @public
|
|
1887
1887
|
*/
|
|
1888
|
-
tags?: Record<string, string
|
|
1888
|
+
tags?: Record<string, string> | undefined;
|
|
1889
1889
|
}
|
|
1890
1890
|
/**
|
|
1891
1891
|
* @public
|
|
@@ -1970,12 +1970,12 @@ export interface ListAgentAliasesRequest {
|
|
|
1970
1970
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
1971
1971
|
* @public
|
|
1972
1972
|
*/
|
|
1973
|
-
maxResults?: number;
|
|
1973
|
+
maxResults?: number | undefined;
|
|
1974
1974
|
/**
|
|
1975
1975
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
1976
1976
|
* @public
|
|
1977
1977
|
*/
|
|
1978
|
-
nextToken?: string;
|
|
1978
|
+
nextToken?: string | undefined;
|
|
1979
1979
|
}
|
|
1980
1980
|
/**
|
|
1981
1981
|
* @public
|
|
@@ -1990,7 +1990,7 @@ export interface ListAgentAliasesResponse {
|
|
|
1990
1990
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
1991
1991
|
* @public
|
|
1992
1992
|
*/
|
|
1993
|
-
nextToken?: string;
|
|
1993
|
+
nextToken?: string | undefined;
|
|
1994
1994
|
}
|
|
1995
1995
|
/**
|
|
1996
1996
|
* @public
|
|
@@ -2015,12 +2015,12 @@ export interface UpdateAgentAliasRequest {
|
|
|
2015
2015
|
* <p>Specifies a new description for the alias.</p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
|
-
description?: string;
|
|
2018
|
+
description?: string | undefined;
|
|
2019
2019
|
/**
|
|
2020
2020
|
* <p>Contains details about the routing configuration of the alias.</p>
|
|
2021
2021
|
* @public
|
|
2022
2022
|
*/
|
|
2023
|
-
routingConfiguration?: AgentAliasRoutingConfigurationListItem[];
|
|
2023
|
+
routingConfiguration?: AgentAliasRoutingConfigurationListItem[] | undefined;
|
|
2024
2024
|
}
|
|
2025
2025
|
/**
|
|
2026
2026
|
* @public
|
|
@@ -2062,7 +2062,7 @@ export interface PatternObjectFilter {
|
|
|
2062
2062
|
* and the document isn’t crawled.</p>
|
|
2063
2063
|
* @public
|
|
2064
2064
|
*/
|
|
2065
|
-
inclusionFilters?: string[];
|
|
2065
|
+
inclusionFilters?: string[] | undefined;
|
|
2066
2066
|
/**
|
|
2067
2067
|
* <p>A list of one or more exclusion regular expression patterns to exclude certain
|
|
2068
2068
|
* object types that adhere to the pattern. If you specify an inclusion and exclusion
|
|
@@ -2070,7 +2070,7 @@ export interface PatternObjectFilter {
|
|
|
2070
2070
|
* and the document isn’t crawled.</p>
|
|
2071
2071
|
* @public
|
|
2072
2072
|
*/
|
|
2073
|
-
exclusionFilters?: string[];
|
|
2073
|
+
exclusionFilters?: string[] | undefined;
|
|
2074
2074
|
}
|
|
2075
2075
|
/**
|
|
2076
2076
|
* <p>The configuration of filtering certain objects or content types of the data source.</p>
|
|
@@ -2112,7 +2112,7 @@ export interface CrawlFilterConfiguration {
|
|
|
2112
2112
|
* <p>The configuration of filtering certain objects or content types of the data source.</p>
|
|
2113
2113
|
* @public
|
|
2114
2114
|
*/
|
|
2115
|
-
patternObjectFilter?: PatternObjectFilterConfiguration;
|
|
2115
|
+
patternObjectFilter?: PatternObjectFilterConfiguration | undefined;
|
|
2116
2116
|
}
|
|
2117
2117
|
/**
|
|
2118
2118
|
* <p>The configuration of the Confluence content. For example, configuring specific
|
|
@@ -2125,7 +2125,7 @@ export interface ConfluenceCrawlerConfiguration {
|
|
|
2125
2125
|
* regular expression patterns to include or exclude certain content.</p>
|
|
2126
2126
|
* @public
|
|
2127
2127
|
*/
|
|
2128
|
-
filterConfiguration?: CrawlFilterConfiguration;
|
|
2128
|
+
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2129
2129
|
}
|
|
2130
2130
|
/**
|
|
2131
2131
|
* @public
|
|
@@ -2196,7 +2196,7 @@ export interface ConfluenceDataSourceConfiguration {
|
|
|
2196
2196
|
* specific types of Confluence content.</p>
|
|
2197
2197
|
* @public
|
|
2198
2198
|
*/
|
|
2199
|
-
crawlerConfiguration?: ConfluenceCrawlerConfiguration;
|
|
2199
|
+
crawlerConfiguration?: ConfluenceCrawlerConfiguration | undefined;
|
|
2200
2200
|
}
|
|
2201
2201
|
/**
|
|
2202
2202
|
* <p>The configuration information to connect to Amazon S3 as your data source.</p>
|
|
@@ -2213,12 +2213,12 @@ export interface S3DataSourceConfiguration {
|
|
|
2213
2213
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a>.</p>
|
|
2214
2214
|
* @public
|
|
2215
2215
|
*/
|
|
2216
|
-
inclusionPrefixes?: string[];
|
|
2216
|
+
inclusionPrefixes?: string[] | undefined;
|
|
2217
2217
|
/**
|
|
2218
2218
|
* <p>The account ID for the owner of the S3 bucket.</p>
|
|
2219
2219
|
* @public
|
|
2220
2220
|
*/
|
|
2221
|
-
bucketOwnerAccountId?: string;
|
|
2221
|
+
bucketOwnerAccountId?: string | undefined;
|
|
2222
2222
|
}
|
|
2223
2223
|
/**
|
|
2224
2224
|
* <p>The configuration of the Salesforce content. For example, configuring
|
|
@@ -2232,7 +2232,7 @@ export interface SalesforceCrawlerConfiguration {
|
|
|
2232
2232
|
* content.</p>
|
|
2233
2233
|
* @public
|
|
2234
2234
|
*/
|
|
2235
|
-
filterConfiguration?: CrawlFilterConfiguration;
|
|
2235
|
+
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2236
2236
|
}
|
|
2237
2237
|
/**
|
|
2238
2238
|
* @public
|
|
@@ -2286,7 +2286,7 @@ export interface SalesforceDataSourceConfiguration {
|
|
|
2286
2286
|
* specific types of Salesforce content.</p>
|
|
2287
2287
|
* @public
|
|
2288
2288
|
*/
|
|
2289
|
-
crawlerConfiguration?: SalesforceCrawlerConfiguration;
|
|
2289
|
+
crawlerConfiguration?: SalesforceCrawlerConfiguration | undefined;
|
|
2290
2290
|
}
|
|
2291
2291
|
/**
|
|
2292
2292
|
* <p>The configuration of the SharePoint content. For example, configuring
|
|
@@ -2299,7 +2299,7 @@ export interface SharePointCrawlerConfiguration {
|
|
|
2299
2299
|
* configuring regular expression patterns to include or exclude certain content.</p>
|
|
2300
2300
|
* @public
|
|
2301
2301
|
*/
|
|
2302
|
-
filterConfiguration?: CrawlFilterConfiguration;
|
|
2302
|
+
filterConfiguration?: CrawlFilterConfiguration | undefined;
|
|
2303
2303
|
}
|
|
2304
2304
|
/**
|
|
2305
2305
|
* @public
|
|
@@ -2332,7 +2332,7 @@ export interface SharePointSourceConfiguration {
|
|
|
2332
2332
|
* <p>The identifier of your Microsoft 365 tenant.</p>
|
|
2333
2333
|
* @public
|
|
2334
2334
|
*/
|
|
2335
|
-
tenantId?: string;
|
|
2335
|
+
tenantId?: string | undefined;
|
|
2336
2336
|
/**
|
|
2337
2337
|
* <p>The domain of your SharePoint instance or site URL/URLs.</p>
|
|
2338
2338
|
* @public
|
|
@@ -2379,7 +2379,7 @@ export interface SharePointDataSourceConfiguration {
|
|
|
2379
2379
|
* specific types of SharePoint content.</p>
|
|
2380
2380
|
* @public
|
|
2381
2381
|
*/
|
|
2382
|
-
crawlerConfiguration?: SharePointCrawlerConfiguration;
|
|
2382
|
+
crawlerConfiguration?: SharePointCrawlerConfiguration | undefined;
|
|
2383
2383
|
}
|
|
2384
2384
|
/**
|
|
2385
2385
|
* @public
|
|
@@ -2406,7 +2406,7 @@ export interface WebCrawlerLimits {
|
|
|
2406
2406
|
* <p>The max rate at which pages are crawled, up to 300 per minute per host.</p>
|
|
2407
2407
|
* @public
|
|
2408
2408
|
*/
|
|
2409
|
-
rateLimit?: number;
|
|
2409
|
+
rateLimit?: number | undefined;
|
|
2410
2410
|
}
|
|
2411
2411
|
/**
|
|
2412
2412
|
* @public
|
|
@@ -2430,7 +2430,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2430
2430
|
* <p>The configuration of crawl limits for the web URLs.</p>
|
|
2431
2431
|
* @public
|
|
2432
2432
|
*/
|
|
2433
|
-
crawlerLimits?: WebCrawlerLimits;
|
|
2433
|
+
crawlerLimits?: WebCrawlerLimits | undefined;
|
|
2434
2434
|
/**
|
|
2435
2435
|
* <p>A list of one or more inclusion regular expression patterns to include
|
|
2436
2436
|
* certain URLs. If you specify an inclusion and exclusion filter/pattern
|
|
@@ -2438,7 +2438,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2438
2438
|
* content of the URL isn’t crawled.</p>
|
|
2439
2439
|
* @public
|
|
2440
2440
|
*/
|
|
2441
|
-
inclusionFilters?: string[];
|
|
2441
|
+
inclusionFilters?: string[] | undefined;
|
|
2442
2442
|
/**
|
|
2443
2443
|
* <p>A list of one or more exclusion regular expression patterns to exclude
|
|
2444
2444
|
* certain URLs. If you specify an inclusion and exclusion filter/pattern
|
|
@@ -2446,7 +2446,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2446
2446
|
* content of the URL isn’t crawled.</p>
|
|
2447
2447
|
* @public
|
|
2448
2448
|
*/
|
|
2449
|
-
exclusionFilters?: string[];
|
|
2449
|
+
exclusionFilters?: string[] | undefined;
|
|
2450
2450
|
/**
|
|
2451
2451
|
* <p>The scope of what is crawled for your URLs.</p>
|
|
2452
2452
|
* <p>You can choose to crawl only web pages that belong to the same host or primary
|
|
@@ -2457,7 +2457,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2457
2457
|
* "docs.aws.amazon.com".</p>
|
|
2458
2458
|
* @public
|
|
2459
2459
|
*/
|
|
2460
|
-
scope?: WebScopeType;
|
|
2460
|
+
scope?: WebScopeType | undefined;
|
|
2461
2461
|
}
|
|
2462
2462
|
/**
|
|
2463
2463
|
* <p>The seed or starting point URL.
|
|
@@ -2469,7 +2469,7 @@ export interface SeedUrl {
|
|
|
2469
2469
|
* <p>A seed or starting point URL.</p>
|
|
2470
2470
|
* @public
|
|
2471
2471
|
*/
|
|
2472
|
-
url?: string;
|
|
2472
|
+
url?: string | undefined;
|
|
2473
2473
|
}
|
|
2474
2474
|
/**
|
|
2475
2475
|
* <p>The configuration of web URLs that you want to crawl.
|
|
@@ -2481,7 +2481,7 @@ export interface UrlConfiguration {
|
|
|
2481
2481
|
* <p>One or more seed or starting point URLs.</p>
|
|
2482
2482
|
* @public
|
|
2483
2483
|
*/
|
|
2484
|
-
seedUrls?: SeedUrl[];
|
|
2484
|
+
seedUrls?: SeedUrl[] | undefined;
|
|
2485
2485
|
}
|
|
2486
2486
|
/**
|
|
2487
2487
|
* <p>The configuration of the URL/URLs for the web content that you want
|
|
@@ -2509,7 +2509,7 @@ export interface WebDataSourceConfiguration {
|
|
|
2509
2509
|
* <p>The Web Crawler configuration details for the web data source.</p>
|
|
2510
2510
|
* @public
|
|
2511
2511
|
*/
|
|
2512
|
-
crawlerConfiguration?: WebCrawlerConfiguration;
|
|
2512
|
+
crawlerConfiguration?: WebCrawlerConfiguration | undefined;
|
|
2513
2513
|
}
|
|
2514
2514
|
/**
|
|
2515
2515
|
* <p>The connection configuration for the data source.</p>
|
|
@@ -2525,7 +2525,7 @@ export interface DataSourceConfiguration {
|
|
|
2525
2525
|
* <p>The configuration information to connect to Amazon S3 as your data source.</p>
|
|
2526
2526
|
* @public
|
|
2527
2527
|
*/
|
|
2528
|
-
s3Configuration?: S3DataSourceConfiguration;
|
|
2528
|
+
s3Configuration?: S3DataSourceConfiguration | undefined;
|
|
2529
2529
|
/**
|
|
2530
2530
|
* <p>The configuration of web URLs to crawl for your data source.
|
|
2531
2531
|
* You should be authorized to crawl the URLs.</p>
|
|
@@ -2535,7 +2535,7 @@ export interface DataSourceConfiguration {
|
|
|
2535
2535
|
* </note>
|
|
2536
2536
|
* @public
|
|
2537
2537
|
*/
|
|
2538
|
-
webConfiguration?: WebDataSourceConfiguration;
|
|
2538
|
+
webConfiguration?: WebDataSourceConfiguration | undefined;
|
|
2539
2539
|
/**
|
|
2540
2540
|
* <p>The configuration information to connect to Confluence as your data source.</p>
|
|
2541
2541
|
* <note>
|
|
@@ -2543,7 +2543,7 @@ export interface DataSourceConfiguration {
|
|
|
2543
2543
|
* </note>
|
|
2544
2544
|
* @public
|
|
2545
2545
|
*/
|
|
2546
|
-
confluenceConfiguration?: ConfluenceDataSourceConfiguration;
|
|
2546
|
+
confluenceConfiguration?: ConfluenceDataSourceConfiguration | undefined;
|
|
2547
2547
|
/**
|
|
2548
2548
|
* <p>The configuration information to connect to Salesforce as your data source.</p>
|
|
2549
2549
|
* <note>
|
|
@@ -2551,7 +2551,7 @@ export interface DataSourceConfiguration {
|
|
|
2551
2551
|
* </note>
|
|
2552
2552
|
* @public
|
|
2553
2553
|
*/
|
|
2554
|
-
salesforceConfiguration?: SalesforceDataSourceConfiguration;
|
|
2554
|
+
salesforceConfiguration?: SalesforceDataSourceConfiguration | undefined;
|
|
2555
2555
|
/**
|
|
2556
2556
|
* <p>The configuration information to connect to SharePoint as your data source.</p>
|
|
2557
2557
|
* <note>
|
|
@@ -2559,7 +2559,7 @@ export interface DataSourceConfiguration {
|
|
|
2559
2559
|
* </note>
|
|
2560
2560
|
* @public
|
|
2561
2561
|
*/
|
|
2562
|
-
sharePointConfiguration?: SharePointDataSourceConfiguration;
|
|
2562
|
+
sharePointConfiguration?: SharePointDataSourceConfiguration | undefined;
|
|
2563
2563
|
}
|
|
2564
2564
|
/**
|
|
2565
2565
|
* <p>Contains the configuration for server-side encryption.</p>
|
|
@@ -2570,7 +2570,7 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
2570
2570
|
* <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.</p>
|
|
2571
2571
|
* @public
|
|
2572
2572
|
*/
|
|
2573
|
-
kmsKeyArn?: string;
|
|
2573
|
+
kmsKeyArn?: string | undefined;
|
|
2574
2574
|
}
|
|
2575
2575
|
/**
|
|
2576
2576
|
* @public
|
|
@@ -2699,21 +2699,21 @@ export interface ChunkingConfiguration {
|
|
|
2699
2699
|
* <p>Configurations for when you choose fixed-size chunking. If you set the <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
2700
2700
|
* @public
|
|
2701
2701
|
*/
|
|
2702
|
-
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
|
|
2702
|
+
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration | undefined;
|
|
2703
2703
|
/**
|
|
2704
2704
|
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents
|
|
2705
2705
|
* into layers of chunks where the first layer contains large chunks, and the second layer contains smaller
|
|
2706
2706
|
* chunks derived from the first layer.</p>
|
|
2707
2707
|
* @public
|
|
2708
2708
|
*/
|
|
2709
|
-
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration;
|
|
2709
|
+
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration | undefined;
|
|
2710
2710
|
/**
|
|
2711
2711
|
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits
|
|
2712
2712
|
* a document into into smaller documents based on groups of similar content derived from the text
|
|
2713
2713
|
* with natural language processing.</p>
|
|
2714
2714
|
* @public
|
|
2715
2715
|
*/
|
|
2716
|
-
semanticChunkingConfiguration?: SemanticChunkingConfiguration;
|
|
2716
|
+
semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
|
|
2717
2717
|
}
|
|
2718
2718
|
/**
|
|
2719
2719
|
* <p>An Amazon S3 location.</p>
|
|
@@ -2838,7 +2838,7 @@ export interface BedrockFoundationModelConfiguration {
|
|
|
2838
2838
|
* <p>Instructions for interpreting the contents of a document.</p>
|
|
2839
2839
|
* @public
|
|
2840
2840
|
*/
|
|
2841
|
-
parsingPrompt?: ParsingPrompt;
|
|
2841
|
+
parsingPrompt?: ParsingPrompt | undefined;
|
|
2842
2842
|
}
|
|
2843
2843
|
/**
|
|
2844
2844
|
* @public
|
|
@@ -2883,7 +2883,7 @@ export interface ParsingConfiguration {
|
|
|
2883
2883
|
* <p>Settings for a foundation model used to parse documents for a data source.</p>
|
|
2884
2884
|
* @public
|
|
2885
2885
|
*/
|
|
2886
|
-
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfiguration;
|
|
2886
|
+
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfiguration | undefined;
|
|
2887
2887
|
}
|
|
2888
2888
|
/**
|
|
2889
2889
|
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
@@ -2894,17 +2894,17 @@ export interface VectorIngestionConfiguration {
|
|
|
2894
2894
|
* <p>Details about how to chunk the documents in the data source. A <i>chunk</i> refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.</p>
|
|
2895
2895
|
* @public
|
|
2896
2896
|
*/
|
|
2897
|
-
chunkingConfiguration?: ChunkingConfiguration;
|
|
2897
|
+
chunkingConfiguration?: ChunkingConfiguration | undefined;
|
|
2898
2898
|
/**
|
|
2899
2899
|
* <p>A custom document transformer for parsed data source documents.</p>
|
|
2900
2900
|
* @public
|
|
2901
2901
|
*/
|
|
2902
|
-
customTransformationConfiguration?: CustomTransformationConfiguration;
|
|
2902
|
+
customTransformationConfiguration?: CustomTransformationConfiguration | undefined;
|
|
2903
2903
|
/**
|
|
2904
2904
|
* <p>A custom parser for data source documents.</p>
|
|
2905
2905
|
* @public
|
|
2906
2906
|
*/
|
|
2907
|
-
parsingConfiguration?: ParsingConfiguration;
|
|
2907
|
+
parsingConfiguration?: ParsingConfiguration | undefined;
|
|
2908
2908
|
}
|
|
2909
2909
|
/**
|
|
2910
2910
|
* @public
|
|
@@ -2920,7 +2920,7 @@ export interface CreateDataSourceRequest {
|
|
|
2920
2920
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
2921
2921
|
* @public
|
|
2922
2922
|
*/
|
|
2923
|
-
clientToken?: string;
|
|
2923
|
+
clientToken?: string | undefined;
|
|
2924
2924
|
/**
|
|
2925
2925
|
* <p>The name of the data source.</p>
|
|
2926
2926
|
* @public
|
|
@@ -2930,7 +2930,7 @@ export interface CreateDataSourceRequest {
|
|
|
2930
2930
|
* <p>A description of the data source.</p>
|
|
2931
2931
|
* @public
|
|
2932
2932
|
*/
|
|
2933
|
-
description?: string;
|
|
2933
|
+
description?: string | undefined;
|
|
2934
2934
|
/**
|
|
2935
2935
|
* <p>The connection configuration for the data source.</p>
|
|
2936
2936
|
* @public
|
|
@@ -2955,17 +2955,17 @@ export interface CreateDataSourceRequest {
|
|
|
2955
2955
|
* </ul>
|
|
2956
2956
|
* @public
|
|
2957
2957
|
*/
|
|
2958
|
-
dataDeletionPolicy?: DataDeletionPolicy;
|
|
2958
|
+
dataDeletionPolicy?: DataDeletionPolicy | undefined;
|
|
2959
2959
|
/**
|
|
2960
2960
|
* <p>Contains details about the server-side encryption for the data source.</p>
|
|
2961
2961
|
* @public
|
|
2962
2962
|
*/
|
|
2963
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2963
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
2964
2964
|
/**
|
|
2965
2965
|
* <p>Contains details about how to ingest the documents in the data source.</p>
|
|
2966
2966
|
* @public
|
|
2967
2967
|
*/
|
|
2968
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
2968
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
2969
2969
|
}
|
|
2970
2970
|
/**
|
|
2971
2971
|
* @public
|
|
@@ -3017,7 +3017,7 @@ export interface DataSource {
|
|
|
3017
3017
|
* <p>The description of the data source.</p>
|
|
3018
3018
|
* @public
|
|
3019
3019
|
*/
|
|
3020
|
-
description?: string;
|
|
3020
|
+
description?: string | undefined;
|
|
3021
3021
|
/**
|
|
3022
3022
|
* <p>The connection configuration for the data source.</p>
|
|
3023
3023
|
* @public
|
|
@@ -3027,17 +3027,17 @@ export interface DataSource {
|
|
|
3027
3027
|
* <p>Contains details about the configuration of the server-side encryption.</p>
|
|
3028
3028
|
* @public
|
|
3029
3029
|
*/
|
|
3030
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
3030
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
3031
3031
|
/**
|
|
3032
3032
|
* <p>Contains details about how to ingest the documents in the data source.</p>
|
|
3033
3033
|
* @public
|
|
3034
3034
|
*/
|
|
3035
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
3035
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
3036
3036
|
/**
|
|
3037
3037
|
* <p>The data deletion policy for the data source.</p>
|
|
3038
3038
|
* @public
|
|
3039
3039
|
*/
|
|
3040
|
-
dataDeletionPolicy?: DataDeletionPolicy;
|
|
3040
|
+
dataDeletionPolicy?: DataDeletionPolicy | undefined;
|
|
3041
3041
|
/**
|
|
3042
3042
|
* <p>The time at which the data source was created.</p>
|
|
3043
3043
|
* @public
|
|
@@ -3052,7 +3052,7 @@ export interface DataSource {
|
|
|
3052
3052
|
* <p>The detailed reasons on the failure to delete a data source.</p>
|
|
3053
3053
|
* @public
|
|
3054
3054
|
*/
|
|
3055
|
-
failureReasons?: string[];
|
|
3055
|
+
failureReasons?: string[] | undefined;
|
|
3056
3056
|
}
|
|
3057
3057
|
/**
|
|
3058
3058
|
* @public
|
|
@@ -3137,12 +3137,12 @@ export interface ListDataSourcesRequest {
|
|
|
3137
3137
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
3138
3138
|
* @public
|
|
3139
3139
|
*/
|
|
3140
|
-
maxResults?: number;
|
|
3140
|
+
maxResults?: number | undefined;
|
|
3141
3141
|
/**
|
|
3142
3142
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
3143
3143
|
* @public
|
|
3144
3144
|
*/
|
|
3145
|
-
nextToken?: string;
|
|
3145
|
+
nextToken?: string | undefined;
|
|
3146
3146
|
}
|
|
3147
3147
|
/**
|
|
3148
3148
|
* <p>Contains details about a data source.</p>
|
|
@@ -3173,7 +3173,7 @@ export interface DataSourceSummary {
|
|
|
3173
3173
|
* <p>The description of the data source.</p>
|
|
3174
3174
|
* @public
|
|
3175
3175
|
*/
|
|
3176
|
-
description?: string;
|
|
3176
|
+
description?: string | undefined;
|
|
3177
3177
|
/**
|
|
3178
3178
|
* <p>The time at which the data source was last updated.</p>
|
|
3179
3179
|
* @public
|
|
@@ -3193,7 +3193,7 @@ export interface ListDataSourcesResponse {
|
|
|
3193
3193
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
3194
3194
|
* @public
|
|
3195
3195
|
*/
|
|
3196
|
-
nextToken?: string;
|
|
3196
|
+
nextToken?: string | undefined;
|
|
3197
3197
|
}
|
|
3198
3198
|
/**
|
|
3199
3199
|
* @public
|
|
@@ -3218,7 +3218,7 @@ export interface UpdateDataSourceRequest {
|
|
|
3218
3218
|
* <p>Specifies a new description for the data source.</p>
|
|
3219
3219
|
* @public
|
|
3220
3220
|
*/
|
|
3221
|
-
description?: string;
|
|
3221
|
+
description?: string | undefined;
|
|
3222
3222
|
/**
|
|
3223
3223
|
* <p>The connection configuration for the data source that you want to update.</p>
|
|
3224
3224
|
* @public
|
|
@@ -3228,17 +3228,17 @@ export interface UpdateDataSourceRequest {
|
|
|
3228
3228
|
* <p>The data deletion policy for the data source that you want to update.</p>
|
|
3229
3229
|
* @public
|
|
3230
3230
|
*/
|
|
3231
|
-
dataDeletionPolicy?: DataDeletionPolicy;
|
|
3231
|
+
dataDeletionPolicy?: DataDeletionPolicy | undefined;
|
|
3232
3232
|
/**
|
|
3233
3233
|
* <p>Contains details about server-side encryption of the data source.</p>
|
|
3234
3234
|
* @public
|
|
3235
3235
|
*/
|
|
3236
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
3236
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
3237
3237
|
/**
|
|
3238
3238
|
* <p>Contains details about how to ingest the documents in the data source.</p>
|
|
3239
3239
|
* @public
|
|
3240
3240
|
*/
|
|
3241
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
3241
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
3242
3242
|
}
|
|
3243
3243
|
/**
|
|
3244
3244
|
* @public
|
|
@@ -3360,7 +3360,7 @@ export interface FlowConnection {
|
|
|
3360
3360
|
* <p>The configuration of the connection.</p>
|
|
3361
3361
|
* @public
|
|
3362
3362
|
*/
|
|
3363
|
-
configuration?: FlowConnectionConfiguration;
|
|
3363
|
+
configuration?: FlowConnectionConfiguration | undefined;
|
|
3364
3364
|
}
|
|
3365
3365
|
/**
|
|
3366
3366
|
* <p>Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html">Node types in Amazon Bedrock works</a> in the Amazon Bedrock User Guide.</p>
|
|
@@ -3382,7 +3382,7 @@ export interface FlowCondition {
|
|
|
3382
3382
|
* <p>Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes">Node types in prompt flows</a>.</p>
|
|
3383
3383
|
* @public
|
|
3384
3384
|
*/
|
|
3385
|
-
expression?: string;
|
|
3385
|
+
expression?: string | undefined;
|
|
3386
3386
|
}
|
|
3387
3387
|
/**
|
|
3388
3388
|
* <p>Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html">Node types in Amazon Bedrock works</a> in the Amazon Bedrock User Guide.</p>
|
|
@@ -3422,12 +3422,12 @@ export interface KnowledgeBaseFlowNodeConfiguration {
|
|
|
3422
3422
|
* <p>The unique identifier of the model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.</p>
|
|
3423
3423
|
* @public
|
|
3424
3424
|
*/
|
|
3425
|
-
modelId?: string;
|
|
3425
|
+
modelId?: string | undefined;
|
|
3426
3426
|
/**
|
|
3427
3427
|
* <p>Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.</p>
|
|
3428
3428
|
* @public
|
|
3429
3429
|
*/
|
|
3430
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3430
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3431
3431
|
}
|
|
3432
3432
|
/**
|
|
3433
3433
|
* <p>Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html">Node types in Amazon Bedrock works</a> in the Amazon Bedrock User Guide.</p>
|
|
@@ -3471,22 +3471,22 @@ export interface PromptModelInferenceConfiguration {
|
|
|
3471
3471
|
* <p>Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.</p>
|
|
3472
3472
|
* @public
|
|
3473
3473
|
*/
|
|
3474
|
-
temperature?: number;
|
|
3474
|
+
temperature?: number | undefined;
|
|
3475
3475
|
/**
|
|
3476
3476
|
* <p>The percentage of most-likely candidates that the model considers for the next token.</p>
|
|
3477
3477
|
* @public
|
|
3478
3478
|
*/
|
|
3479
|
-
topP?: number;
|
|
3479
|
+
topP?: number | undefined;
|
|
3480
3480
|
/**
|
|
3481
3481
|
* <p>The maximum number of tokens to return in the response.</p>
|
|
3482
3482
|
* @public
|
|
3483
3483
|
*/
|
|
3484
|
-
maxTokens?: number;
|
|
3484
|
+
maxTokens?: number | undefined;
|
|
3485
3485
|
/**
|
|
3486
3486
|
* <p>A list of strings that define sequences after which the model will stop generating.</p>
|
|
3487
3487
|
* @public
|
|
3488
3488
|
*/
|
|
3489
|
-
stopSequences?: string[];
|
|
3489
|
+
stopSequences?: string[] | undefined;
|
|
3490
3490
|
}
|
|
3491
3491
|
/**
|
|
3492
3492
|
* <p>Contains inference configurations for the prompt.</p>
|
|
@@ -3527,7 +3527,7 @@ export interface PromptInputVariable {
|
|
|
3527
3527
|
* <p>The name of the variable.</p>
|
|
3528
3528
|
* @public
|
|
3529
3529
|
*/
|
|
3530
|
-
name?: string;
|
|
3530
|
+
name?: string | undefined;
|
|
3531
3531
|
}
|
|
3532
3532
|
/**
|
|
3533
3533
|
* <p>Contains the content for the message you pass to, or receive from a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
|
|
@@ -3740,7 +3740,7 @@ export interface ToolSpecification {
|
|
|
3740
3740
|
* <p>The description of the tool.</p>
|
|
3741
3741
|
* @public
|
|
3742
3742
|
*/
|
|
3743
|
-
description?: string;
|
|
3743
|
+
description?: string | undefined;
|
|
3744
3744
|
/**
|
|
3745
3745
|
* <p>The input schema for the tool.</p>
|
|
3746
3746
|
* @public
|
|
@@ -3791,7 +3791,7 @@ export interface ToolConfiguration {
|
|
|
3791
3791
|
* <p>Defines which tools the model should request when invoked.</p>
|
|
3792
3792
|
* @public
|
|
3793
3793
|
*/
|
|
3794
|
-
toolChoice?: ToolChoice;
|
|
3794
|
+
toolChoice?: ToolChoice | undefined;
|
|
3795
3795
|
}
|
|
3796
3796
|
/**
|
|
3797
3797
|
* <p>Contains configurations to use a prompt in a conversational format. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
|
|
@@ -3807,17 +3807,17 @@ export interface ChatPromptTemplateConfiguration {
|
|
|
3807
3807
|
* <p>Contains system prompts to provide context to the model or to describe how it should behave.</p>
|
|
3808
3808
|
* @public
|
|
3809
3809
|
*/
|
|
3810
|
-
system?: SystemContentBlock[];
|
|
3810
|
+
system?: SystemContentBlock[] | undefined;
|
|
3811
3811
|
/**
|
|
3812
3812
|
* <p>An array of the variables in the prompt template.</p>
|
|
3813
3813
|
* @public
|
|
3814
3814
|
*/
|
|
3815
|
-
inputVariables?: PromptInputVariable[];
|
|
3815
|
+
inputVariables?: PromptInputVariable[] | undefined;
|
|
3816
3816
|
/**
|
|
3817
3817
|
* <p>Configuration information for the tools that the model can use when generating a response.</p>
|
|
3818
3818
|
* @public
|
|
3819
3819
|
*/
|
|
3820
|
-
toolConfiguration?: ToolConfiguration;
|
|
3820
|
+
toolConfiguration?: ToolConfiguration | undefined;
|
|
3821
3821
|
}
|
|
3822
3822
|
/**
|
|
3823
3823
|
* <p>Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in <code>\{\{variable\}\}</code>.</p>
|
|
@@ -3833,7 +3833,7 @@ export interface TextPromptTemplateConfiguration {
|
|
|
3833
3833
|
* <p>An array of the variables in the prompt template.</p>
|
|
3834
3834
|
* @public
|
|
3835
3835
|
*/
|
|
3836
|
-
inputVariables?: PromptInputVariable[];
|
|
3836
|
+
inputVariables?: PromptInputVariable[] | undefined;
|
|
3837
3837
|
}
|
|
3838
3838
|
/**
|
|
3839
3839
|
* <p>Contains the message for a prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Construct and store reusable prompts with Prompt management in Amazon Bedrock</a>.</p>
|
|
@@ -3913,12 +3913,12 @@ export interface PromptFlowNodeInlineConfiguration {
|
|
|
3913
3913
|
* <p>Contains inference configurations for the prompt.</p>
|
|
3914
3914
|
* @public
|
|
3915
3915
|
*/
|
|
3916
|
-
inferenceConfiguration?: PromptInferenceConfiguration;
|
|
3916
|
+
inferenceConfiguration?: PromptInferenceConfiguration | undefined;
|
|
3917
3917
|
/**
|
|
3918
3918
|
* <p>Additional fields to be included in the model request for the Prompt node.</p>
|
|
3919
3919
|
* @public
|
|
3920
3920
|
*/
|
|
3921
|
-
additionalModelRequestFields?: __DocumentType;
|
|
3921
|
+
additionalModelRequestFields?: __DocumentType | undefined;
|
|
3922
3922
|
}
|
|
3923
3923
|
/**
|
|
3924
3924
|
* <p>Contains configurations for a prompt from Prompt management to use in a node.</p>
|
|
@@ -3987,7 +3987,7 @@ export interface PromptFlowNodeConfiguration {
|
|
|
3987
3987
|
* <p>Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.</p>
|
|
3988
3988
|
* @public
|
|
3989
3989
|
*/
|
|
3990
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3990
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3991
3991
|
}
|
|
3992
3992
|
/**
|
|
3993
3993
|
* <p>Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.</p>
|
|
@@ -4459,17 +4459,17 @@ export interface FlowNode {
|
|
|
4459
4459
|
* <p>Contains configurations for the node.</p>
|
|
4460
4460
|
* @public
|
|
4461
4461
|
*/
|
|
4462
|
-
configuration?: FlowNodeConfiguration;
|
|
4462
|
+
configuration?: FlowNodeConfiguration | undefined;
|
|
4463
4463
|
/**
|
|
4464
4464
|
* <p>An array of objects, each of which contains information about an input into the node.</p>
|
|
4465
4465
|
* @public
|
|
4466
4466
|
*/
|
|
4467
|
-
inputs?: FlowNodeInput[];
|
|
4467
|
+
inputs?: FlowNodeInput[] | undefined;
|
|
4468
4468
|
/**
|
|
4469
4469
|
* <p>A list of objects, each of which contains information about an output from the node.</p>
|
|
4470
4470
|
* @public
|
|
4471
4471
|
*/
|
|
4472
|
-
outputs?: FlowNodeOutput[];
|
|
4472
|
+
outputs?: FlowNodeOutput[] | undefined;
|
|
4473
4473
|
}
|
|
4474
4474
|
/**
|
|
4475
4475
|
* <p>The definition of the nodes and connections between nodes in the flow.</p>
|
|
@@ -4480,12 +4480,12 @@ export interface FlowDefinition {
|
|
|
4480
4480
|
* <p>An array of node definitions in the flow.</p>
|
|
4481
4481
|
* @public
|
|
4482
4482
|
*/
|
|
4483
|
-
nodes?: FlowNode[];
|
|
4483
|
+
nodes?: FlowNode[] | undefined;
|
|
4484
4484
|
/**
|
|
4485
4485
|
* <p>An array of connection definitions in the flow.</p>
|
|
4486
4486
|
* @public
|
|
4487
4487
|
*/
|
|
4488
|
-
connections?: FlowConnection[];
|
|
4488
|
+
connections?: FlowConnection[] | undefined;
|
|
4489
4489
|
}
|
|
4490
4490
|
/**
|
|
4491
4491
|
* @public
|
|
@@ -4500,7 +4500,7 @@ export interface CreateFlowRequest {
|
|
|
4500
4500
|
* <p>A description for the flow.</p>
|
|
4501
4501
|
* @public
|
|
4502
4502
|
*/
|
|
4503
|
-
description?: string;
|
|
4503
|
+
description?: string | undefined;
|
|
4504
4504
|
/**
|
|
4505
4505
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
4506
4506
|
* @public
|
|
@@ -4510,23 +4510,23 @@ export interface CreateFlowRequest {
|
|
|
4510
4510
|
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p>
|
|
4511
4511
|
* @public
|
|
4512
4512
|
*/
|
|
4513
|
-
customerEncryptionKeyArn?: string;
|
|
4513
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
4514
4514
|
/**
|
|
4515
4515
|
* <p>A definition of the nodes and connections between nodes in the flow.</p>
|
|
4516
4516
|
* @public
|
|
4517
4517
|
*/
|
|
4518
|
-
definition?: FlowDefinition;
|
|
4518
|
+
definition?: FlowDefinition | undefined;
|
|
4519
4519
|
/**
|
|
4520
4520
|
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
4521
4521
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
4522
4522
|
* @public
|
|
4523
4523
|
*/
|
|
4524
|
-
clientToken?: string;
|
|
4524
|
+
clientToken?: string | undefined;
|
|
4525
4525
|
/**
|
|
4526
4526
|
* <p>Any tags that you want to attach to the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
|
|
4527
4527
|
* @public
|
|
4528
4528
|
*/
|
|
4529
|
-
tags?: Record<string, string
|
|
4529
|
+
tags?: Record<string, string> | undefined;
|
|
4530
4530
|
}
|
|
4531
4531
|
/**
|
|
4532
4532
|
* @public
|
|
@@ -4555,7 +4555,7 @@ export interface CreateFlowResponse {
|
|
|
4555
4555
|
* <p>The description of the flow.</p>
|
|
4556
4556
|
* @public
|
|
4557
4557
|
*/
|
|
4558
|
-
description?: string;
|
|
4558
|
+
description?: string | undefined;
|
|
4559
4559
|
/**
|
|
4560
4560
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
4561
4561
|
* @public
|
|
@@ -4565,7 +4565,7 @@ export interface CreateFlowResponse {
|
|
|
4565
4565
|
* <p>The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.</p>
|
|
4566
4566
|
* @public
|
|
4567
4567
|
*/
|
|
4568
|
-
customerEncryptionKeyArn?: string;
|
|
4568
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
4569
4569
|
/**
|
|
4570
4570
|
* <p>The unique identifier of the flow.</p>
|
|
4571
4571
|
* @public
|
|
@@ -4600,7 +4600,7 @@ export interface CreateFlowResponse {
|
|
|
4600
4600
|
* <p>A definition of the nodes and connections between nodes in the flow.</p>
|
|
4601
4601
|
* @public
|
|
4602
4602
|
*/
|
|
4603
|
-
definition?: FlowDefinition;
|
|
4603
|
+
definition?: FlowDefinition | undefined;
|
|
4604
4604
|
}
|
|
4605
4605
|
/**
|
|
4606
4606
|
* @public
|
|
@@ -4615,7 +4615,7 @@ export interface DeleteFlowRequest {
|
|
|
4615
4615
|
* <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
|
|
4616
4616
|
* @public
|
|
4617
4617
|
*/
|
|
4618
|
-
skipResourceInUseCheck?: boolean;
|
|
4618
|
+
skipResourceInUseCheck?: boolean | undefined;
|
|
4619
4619
|
}
|
|
4620
4620
|
/**
|
|
4621
4621
|
* @public
|
|
@@ -4636,7 +4636,7 @@ export interface FlowAliasRoutingConfigurationListItem {
|
|
|
4636
4636
|
* <p>The version that the alias maps to.</p>
|
|
4637
4637
|
* @public
|
|
4638
4638
|
*/
|
|
4639
|
-
flowVersion?: string;
|
|
4639
|
+
flowVersion?: string | undefined;
|
|
4640
4640
|
}
|
|
4641
4641
|
/**
|
|
4642
4642
|
* @public
|
|
@@ -4651,7 +4651,7 @@ export interface CreateFlowAliasRequest {
|
|
|
4651
4651
|
* <p>A description for the alias.</p>
|
|
4652
4652
|
* @public
|
|
4653
4653
|
*/
|
|
4654
|
-
description?: string;
|
|
4654
|
+
description?: string | undefined;
|
|
4655
4655
|
/**
|
|
4656
4656
|
* <p>Contains information about the version to which to map the alias.</p>
|
|
4657
4657
|
* @public
|
|
@@ -4667,12 +4667,12 @@ export interface CreateFlowAliasRequest {
|
|
|
4667
4667
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
4668
4668
|
* @public
|
|
4669
4669
|
*/
|
|
4670
|
-
clientToken?: string;
|
|
4670
|
+
clientToken?: string | undefined;
|
|
4671
4671
|
/**
|
|
4672
4672
|
* <p>Any tags that you want to attach to the alias of the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
|
|
4673
4673
|
* @public
|
|
4674
4674
|
*/
|
|
4675
|
-
tags?: Record<string, string
|
|
4675
|
+
tags?: Record<string, string> | undefined;
|
|
4676
4676
|
}
|
|
4677
4677
|
/**
|
|
4678
4678
|
* @public
|
|
@@ -4687,7 +4687,7 @@ export interface CreateFlowAliasResponse {
|
|
|
4687
4687
|
* <p>The description of the alias.</p>
|
|
4688
4688
|
* @public
|
|
4689
4689
|
*/
|
|
4690
|
-
description?: string;
|
|
4690
|
+
description?: string | undefined;
|
|
4691
4691
|
/**
|
|
4692
4692
|
* <p>Contains information about the version that the alias is mapped to.</p>
|
|
4693
4693
|
* @public
|
|
@@ -4777,7 +4777,7 @@ export interface GetFlowAliasResponse {
|
|
|
4777
4777
|
* <p>The description of the flow.</p>
|
|
4778
4778
|
* @public
|
|
4779
4779
|
*/
|
|
4780
|
-
description?: string;
|
|
4780
|
+
description?: string | undefined;
|
|
4781
4781
|
/**
|
|
4782
4782
|
* <p>Contains information about the version that the alias is mapped to.</p>
|
|
4783
4783
|
* @public
|
|
@@ -4822,12 +4822,12 @@ export interface ListFlowAliasesRequest {
|
|
|
4822
4822
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
4823
4823
|
* @public
|
|
4824
4824
|
*/
|
|
4825
|
-
maxResults?: number;
|
|
4825
|
+
maxResults?: number | undefined;
|
|
4826
4826
|
/**
|
|
4827
4827
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
4828
4828
|
* @public
|
|
4829
4829
|
*/
|
|
4830
|
-
nextToken?: string;
|
|
4830
|
+
nextToken?: string | undefined;
|
|
4831
4831
|
}
|
|
4832
4832
|
/**
|
|
4833
4833
|
* <p>Contains information about an alias of a flow.</p>
|
|
@@ -4851,7 +4851,7 @@ export interface FlowAliasSummary {
|
|
|
4851
4851
|
* <p>A description of the alias.</p>
|
|
4852
4852
|
* @public
|
|
4853
4853
|
*/
|
|
4854
|
-
description?: string;
|
|
4854
|
+
description?: string | undefined;
|
|
4855
4855
|
/**
|
|
4856
4856
|
* <p>A list of configurations about the versions that the alias maps to. Currently, you can only specify one.</p>
|
|
4857
4857
|
* @public
|
|
@@ -4896,7 +4896,7 @@ export interface ListFlowAliasesResponse {
|
|
|
4896
4896
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
4897
4897
|
* @public
|
|
4898
4898
|
*/
|
|
4899
|
-
nextToken?: string;
|
|
4899
|
+
nextToken?: string | undefined;
|
|
4900
4900
|
}
|
|
4901
4901
|
/**
|
|
4902
4902
|
* @public
|
|
@@ -4911,7 +4911,7 @@ export interface UpdateFlowAliasRequest {
|
|
|
4911
4911
|
* <p>A description for the alias.</p>
|
|
4912
4912
|
* @public
|
|
4913
4913
|
*/
|
|
4914
|
-
description?: string;
|
|
4914
|
+
description?: string | undefined;
|
|
4915
4915
|
/**
|
|
4916
4916
|
* <p>Contains information about the version to which to map the alias.</p>
|
|
4917
4917
|
* @public
|
|
@@ -4941,7 +4941,7 @@ export interface UpdateFlowAliasResponse {
|
|
|
4941
4941
|
* <p>The description of the flow.</p>
|
|
4942
4942
|
* @public
|
|
4943
4943
|
*/
|
|
4944
|
-
description?: string;
|
|
4944
|
+
description?: string | undefined;
|
|
4945
4945
|
/**
|
|
4946
4946
|
* <p>Contains information about the version that the alias is mapped to.</p>
|
|
4947
4947
|
* @public
|
|
@@ -4986,13 +4986,13 @@ export interface CreateFlowVersionRequest {
|
|
|
4986
4986
|
* <p>A description of the version of the flow.</p>
|
|
4987
4987
|
* @public
|
|
4988
4988
|
*/
|
|
4989
|
-
description?: string;
|
|
4989
|
+
description?: string | undefined;
|
|
4990
4990
|
/**
|
|
4991
4991
|
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
4992
4992
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
4993
4993
|
* @public
|
|
4994
4994
|
*/
|
|
4995
|
-
clientToken?: string;
|
|
4995
|
+
clientToken?: string | undefined;
|
|
4996
4996
|
}
|
|
4997
4997
|
/**
|
|
4998
4998
|
* @public
|
|
@@ -5007,7 +5007,7 @@ export interface CreateFlowVersionResponse {
|
|
|
5007
5007
|
* <p>The description of the version.</p>
|
|
5008
5008
|
* @public
|
|
5009
5009
|
*/
|
|
5010
|
-
description?: string;
|
|
5010
|
+
description?: string | undefined;
|
|
5011
5011
|
/**
|
|
5012
5012
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
5013
5013
|
* @public
|
|
@@ -5017,7 +5017,7 @@ export interface CreateFlowVersionResponse {
|
|
|
5017
5017
|
* <p>The KMS key that the flow is encrypted with.</p>
|
|
5018
5018
|
* @public
|
|
5019
5019
|
*/
|
|
5020
|
-
customerEncryptionKeyArn?: string;
|
|
5020
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
5021
5021
|
/**
|
|
5022
5022
|
* <p>The unique identifier of the flow.</p>
|
|
5023
5023
|
* @public
|
|
@@ -5047,7 +5047,7 @@ export interface CreateFlowVersionResponse {
|
|
|
5047
5047
|
* <p>A definition of the nodes and connections in the flow.</p>
|
|
5048
5048
|
* @public
|
|
5049
5049
|
*/
|
|
5050
|
-
definition?: FlowDefinition;
|
|
5050
|
+
definition?: FlowDefinition | undefined;
|
|
5051
5051
|
}
|
|
5052
5052
|
/**
|
|
5053
5053
|
* @public
|
|
@@ -5067,7 +5067,7 @@ export interface DeleteFlowVersionRequest {
|
|
|
5067
5067
|
* <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
|
|
5068
5068
|
* @public
|
|
5069
5069
|
*/
|
|
5070
|
-
skipResourceInUseCheck?: boolean;
|
|
5070
|
+
skipResourceInUseCheck?: boolean | undefined;
|
|
5071
5071
|
}
|
|
5072
5072
|
/**
|
|
5073
5073
|
* @public
|
|
@@ -5112,7 +5112,7 @@ export interface GetFlowVersionResponse {
|
|
|
5112
5112
|
* <p>The description of the flow.</p>
|
|
5113
5113
|
* @public
|
|
5114
5114
|
*/
|
|
5115
|
-
description?: string;
|
|
5115
|
+
description?: string | undefined;
|
|
5116
5116
|
/**
|
|
5117
5117
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
5118
5118
|
* @public
|
|
@@ -5122,7 +5122,7 @@ export interface GetFlowVersionResponse {
|
|
|
5122
5122
|
* <p>The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.</p>
|
|
5123
5123
|
* @public
|
|
5124
5124
|
*/
|
|
5125
|
-
customerEncryptionKeyArn?: string;
|
|
5125
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
5126
5126
|
/**
|
|
5127
5127
|
* <p>The unique identifier of the flow.</p>
|
|
5128
5128
|
* @public
|
|
@@ -5152,7 +5152,7 @@ export interface GetFlowVersionResponse {
|
|
|
5152
5152
|
* <p>The definition of the nodes and connections between nodes in the flow.</p>
|
|
5153
5153
|
* @public
|
|
5154
5154
|
*/
|
|
5155
|
-
definition?: FlowDefinition;
|
|
5155
|
+
definition?: FlowDefinition | undefined;
|
|
5156
5156
|
}
|
|
5157
5157
|
/**
|
|
5158
5158
|
* @public
|
|
@@ -5167,12 +5167,12 @@ export interface ListFlowVersionsRequest {
|
|
|
5167
5167
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
5168
5168
|
* @public
|
|
5169
5169
|
*/
|
|
5170
|
-
maxResults?: number;
|
|
5170
|
+
maxResults?: number | undefined;
|
|
5171
5171
|
/**
|
|
5172
5172
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
5173
5173
|
* @public
|
|
5174
5174
|
*/
|
|
5175
|
-
nextToken?: string;
|
|
5175
|
+
nextToken?: string | undefined;
|
|
5176
5176
|
}
|
|
5177
5177
|
/**
|
|
5178
5178
|
* <p>Contains information about a version of a flow.</p>
|
|
@@ -5226,7 +5226,7 @@ export interface ListFlowVersionsResponse {
|
|
|
5226
5226
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
5227
5227
|
* @public
|
|
5228
5228
|
*/
|
|
5229
|
-
nextToken?: string;
|
|
5229
|
+
nextToken?: string | undefined;
|
|
5230
5230
|
}
|
|
5231
5231
|
/**
|
|
5232
5232
|
* @public
|
|
@@ -6517,12 +6517,12 @@ export interface FlowValidation {
|
|
|
6517
6517
|
* <p>Specific details about the validation issue encountered in the flow.</p>
|
|
6518
6518
|
* @public
|
|
6519
6519
|
*/
|
|
6520
|
-
details?: FlowValidationDetails;
|
|
6520
|
+
details?: FlowValidationDetails | undefined;
|
|
6521
6521
|
/**
|
|
6522
6522
|
* <p>The type of validation issue encountered in the flow.</p>
|
|
6523
6523
|
* @public
|
|
6524
6524
|
*/
|
|
6525
|
-
type?: FlowValidationType;
|
|
6525
|
+
type?: FlowValidationType | undefined;
|
|
6526
6526
|
}
|
|
6527
6527
|
/**
|
|
6528
6528
|
* @public
|
|
@@ -6537,7 +6537,7 @@ export interface GetFlowResponse {
|
|
|
6537
6537
|
* <p>The description of the flow.</p>
|
|
6538
6538
|
* @public
|
|
6539
6539
|
*/
|
|
6540
|
-
description?: string;
|
|
6540
|
+
description?: string | undefined;
|
|
6541
6541
|
/**
|
|
6542
6542
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service row for flows</a> in the Amazon Bedrock User Guide.</p>
|
|
6543
6543
|
* @public
|
|
@@ -6547,7 +6547,7 @@ export interface GetFlowResponse {
|
|
|
6547
6547
|
* <p>The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.</p>
|
|
6548
6548
|
* @public
|
|
6549
6549
|
*/
|
|
6550
|
-
customerEncryptionKeyArn?: string;
|
|
6550
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
6551
6551
|
/**
|
|
6552
6552
|
* <p>The unique identifier of the flow.</p>
|
|
6553
6553
|
* @public
|
|
@@ -6596,12 +6596,12 @@ export interface GetFlowResponse {
|
|
|
6596
6596
|
* <p>The definition of the nodes and connections between the nodes in the flow.</p>
|
|
6597
6597
|
* @public
|
|
6598
6598
|
*/
|
|
6599
|
-
definition?: FlowDefinition;
|
|
6599
|
+
definition?: FlowDefinition | undefined;
|
|
6600
6600
|
/**
|
|
6601
6601
|
* <p>A list of validation error messages related to the last failed operation on the flow.</p>
|
|
6602
6602
|
* @public
|
|
6603
6603
|
*/
|
|
6604
|
-
validations?: FlowValidation[];
|
|
6604
|
+
validations?: FlowValidation[] | undefined;
|
|
6605
6605
|
}
|
|
6606
6606
|
/**
|
|
6607
6607
|
* @public
|
|
@@ -6611,12 +6611,12 @@ export interface ListFlowsRequest {
|
|
|
6611
6611
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
6612
6612
|
* @public
|
|
6613
6613
|
*/
|
|
6614
|
-
maxResults?: number;
|
|
6614
|
+
maxResults?: number | undefined;
|
|
6615
6615
|
/**
|
|
6616
6616
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
6617
6617
|
* @public
|
|
6618
6618
|
*/
|
|
6619
|
-
nextToken?: string;
|
|
6619
|
+
nextToken?: string | undefined;
|
|
6620
6620
|
}
|
|
6621
6621
|
/**
|
|
6622
6622
|
* <p>Contains the definition of a flow.</p>
|
|
@@ -6632,7 +6632,7 @@ export interface FlowSummary {
|
|
|
6632
6632
|
* <p>A description of the flow.</p>
|
|
6633
6633
|
* @public
|
|
6634
6634
|
*/
|
|
6635
|
-
description?: string;
|
|
6635
|
+
description?: string | undefined;
|
|
6636
6636
|
/**
|
|
6637
6637
|
* <p>The unique identifier of the flow.</p>
|
|
6638
6638
|
* @public
|
|
@@ -6691,7 +6691,7 @@ export interface ListFlowsResponse {
|
|
|
6691
6691
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
6692
6692
|
* @public
|
|
6693
6693
|
*/
|
|
6694
|
-
nextToken?: string;
|
|
6694
|
+
nextToken?: string | undefined;
|
|
6695
6695
|
}
|
|
6696
6696
|
/**
|
|
6697
6697
|
* @public
|
|
@@ -6731,7 +6731,7 @@ export interface UpdateFlowRequest {
|
|
|
6731
6731
|
* <p>A description for the flow.</p>
|
|
6732
6732
|
* @public
|
|
6733
6733
|
*/
|
|
6734
|
-
description?: string;
|
|
6734
|
+
description?: string | undefined;
|
|
6735
6735
|
/**
|
|
6736
6736
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
6737
6737
|
* @public
|
|
@@ -6741,12 +6741,12 @@ export interface UpdateFlowRequest {
|
|
|
6741
6741
|
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.</p>
|
|
6742
6742
|
* @public
|
|
6743
6743
|
*/
|
|
6744
|
-
customerEncryptionKeyArn?: string;
|
|
6744
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
6745
6745
|
/**
|
|
6746
6746
|
* <p>A definition of the nodes and the connections between the nodes in the flow.</p>
|
|
6747
6747
|
* @public
|
|
6748
6748
|
*/
|
|
6749
|
-
definition?: FlowDefinition;
|
|
6749
|
+
definition?: FlowDefinition | undefined;
|
|
6750
6750
|
/**
|
|
6751
6751
|
* <p>The unique identifier of the flow.</p>
|
|
6752
6752
|
* @public
|
|
@@ -6766,7 +6766,7 @@ export interface UpdateFlowResponse {
|
|
|
6766
6766
|
* <p>The description of the flow.</p>
|
|
6767
6767
|
* @public
|
|
6768
6768
|
*/
|
|
6769
|
-
description?: string;
|
|
6769
|
+
description?: string | undefined;
|
|
6770
6770
|
/**
|
|
6771
6771
|
* <p>The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
6772
6772
|
* @public
|
|
@@ -6776,7 +6776,7 @@ export interface UpdateFlowResponse {
|
|
|
6776
6776
|
* <p>The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.</p>
|
|
6777
6777
|
* @public
|
|
6778
6778
|
*/
|
|
6779
|
-
customerEncryptionKeyArn?: string;
|
|
6779
|
+
customerEncryptionKeyArn?: string | undefined;
|
|
6780
6780
|
/**
|
|
6781
6781
|
* <p>The unique identifier of the flow.</p>
|
|
6782
6782
|
* @public
|
|
@@ -6811,7 +6811,7 @@ export interface UpdateFlowResponse {
|
|
|
6811
6811
|
* <p>A definition of the nodes and the connections between nodes in the flow.</p>
|
|
6812
6812
|
* @public
|
|
6813
6813
|
*/
|
|
6814
|
-
definition?: FlowDefinition;
|
|
6814
|
+
definition?: FlowDefinition | undefined;
|
|
6815
6815
|
}
|
|
6816
6816
|
/**
|
|
6817
6817
|
* @public
|
|
@@ -6842,37 +6842,37 @@ export interface IngestionJobStatistics {
|
|
|
6842
6842
|
* <p>The total number of source documents that were scanned. Includes new, updated, and unchanged documents.</p>
|
|
6843
6843
|
* @public
|
|
6844
6844
|
*/
|
|
6845
|
-
numberOfDocumentsScanned?: number;
|
|
6845
|
+
numberOfDocumentsScanned?: number | undefined;
|
|
6846
6846
|
/**
|
|
6847
6847
|
* <p>The total number of metadata files that were scanned. Includes new, updated, and unchanged files.</p>
|
|
6848
6848
|
* @public
|
|
6849
6849
|
*/
|
|
6850
|
-
numberOfMetadataDocumentsScanned?: number;
|
|
6850
|
+
numberOfMetadataDocumentsScanned?: number | undefined;
|
|
6851
6851
|
/**
|
|
6852
6852
|
* <p>The number of new source documents in the data source that were successfully indexed.</p>
|
|
6853
6853
|
* @public
|
|
6854
6854
|
*/
|
|
6855
|
-
numberOfNewDocumentsIndexed?: number;
|
|
6855
|
+
numberOfNewDocumentsIndexed?: number | undefined;
|
|
6856
6856
|
/**
|
|
6857
6857
|
* <p>The number of modified source documents in the data source that were successfully indexed.</p>
|
|
6858
6858
|
* @public
|
|
6859
6859
|
*/
|
|
6860
|
-
numberOfModifiedDocumentsIndexed?: number;
|
|
6860
|
+
numberOfModifiedDocumentsIndexed?: number | undefined;
|
|
6861
6861
|
/**
|
|
6862
6862
|
* <p>The number of metadata files that were updated or deleted.</p>
|
|
6863
6863
|
* @public
|
|
6864
6864
|
*/
|
|
6865
|
-
numberOfMetadataDocumentsModified?: number;
|
|
6865
|
+
numberOfMetadataDocumentsModified?: number | undefined;
|
|
6866
6866
|
/**
|
|
6867
6867
|
* <p>The number of source documents that were deleted.</p>
|
|
6868
6868
|
* @public
|
|
6869
6869
|
*/
|
|
6870
|
-
numberOfDocumentsDeleted?: number;
|
|
6870
|
+
numberOfDocumentsDeleted?: number | undefined;
|
|
6871
6871
|
/**
|
|
6872
6872
|
* <p>The number of source documents that failed to be ingested.</p>
|
|
6873
6873
|
* @public
|
|
6874
6874
|
*/
|
|
6875
|
-
numberOfDocumentsFailed?: number;
|
|
6875
|
+
numberOfDocumentsFailed?: number | undefined;
|
|
6876
6876
|
}
|
|
6877
6877
|
/**
|
|
6878
6878
|
* @public
|
|
@@ -6932,7 +6932,7 @@ export interface IngestionJob {
|
|
|
6932
6932
|
* <p>The description of the data ingestion job.</p>
|
|
6933
6933
|
* @public
|
|
6934
6934
|
*/
|
|
6935
|
-
description?: string;
|
|
6935
|
+
description?: string | undefined;
|
|
6936
6936
|
/**
|
|
6937
6937
|
* <p>The status of the data ingestion job.</p>
|
|
6938
6938
|
* @public
|
|
@@ -6942,12 +6942,12 @@ export interface IngestionJob {
|
|
|
6942
6942
|
* <p>Contains statistics about the data ingestion job.</p>
|
|
6943
6943
|
* @public
|
|
6944
6944
|
*/
|
|
6945
|
-
statistics?: IngestionJobStatistics;
|
|
6945
|
+
statistics?: IngestionJobStatistics | undefined;
|
|
6946
6946
|
/**
|
|
6947
6947
|
* <p>A list of reasons that the data ingestion job failed.</p>
|
|
6948
6948
|
* @public
|
|
6949
6949
|
*/
|
|
6950
|
-
failureReasons?: string[];
|
|
6950
|
+
failureReasons?: string[] | undefined;
|
|
6951
6951
|
/**
|
|
6952
6952
|
* <p>The time the data ingestion job started.</p>
|
|
6953
6953
|
* <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>
|
|
@@ -7072,22 +7072,22 @@ export interface ListIngestionJobsRequest {
|
|
|
7072
7072
|
* <p>Contains information about the filters for filtering the data.</p>
|
|
7073
7073
|
* @public
|
|
7074
7074
|
*/
|
|
7075
|
-
filters?: IngestionJobFilter[];
|
|
7075
|
+
filters?: IngestionJobFilter[] | undefined;
|
|
7076
7076
|
/**
|
|
7077
7077
|
* <p>Contains details about how to sort the data.</p>
|
|
7078
7078
|
* @public
|
|
7079
7079
|
*/
|
|
7080
|
-
sortBy?: IngestionJobSortBy;
|
|
7080
|
+
sortBy?: IngestionJobSortBy | undefined;
|
|
7081
7081
|
/**
|
|
7082
7082
|
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7083
7083
|
* @public
|
|
7084
7084
|
*/
|
|
7085
|
-
maxResults?: number;
|
|
7085
|
+
maxResults?: number | undefined;
|
|
7086
7086
|
/**
|
|
7087
7087
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
7088
7088
|
* @public
|
|
7089
7089
|
*/
|
|
7090
|
-
nextToken?: string;
|
|
7090
|
+
nextToken?: string | undefined;
|
|
7091
7091
|
}
|
|
7092
7092
|
/**
|
|
7093
7093
|
* <p>Contains details about a data ingestion job.</p>
|
|
@@ -7113,7 +7113,7 @@ export interface IngestionJobSummary {
|
|
|
7113
7113
|
* <p>The description of the data ingestion job.</p>
|
|
7114
7114
|
* @public
|
|
7115
7115
|
*/
|
|
7116
|
-
description?: string;
|
|
7116
|
+
description?: string | undefined;
|
|
7117
7117
|
/**
|
|
7118
7118
|
* <p>The status of the data ingestion job.</p>
|
|
7119
7119
|
* @public
|
|
@@ -7133,7 +7133,7 @@ export interface IngestionJobSummary {
|
|
|
7133
7133
|
* <p>Contains statistics for the data ingestion job.</p>
|
|
7134
7134
|
* @public
|
|
7135
7135
|
*/
|
|
7136
|
-
statistics?: IngestionJobStatistics;
|
|
7136
|
+
statistics?: IngestionJobStatistics | undefined;
|
|
7137
7137
|
}
|
|
7138
7138
|
/**
|
|
7139
7139
|
* @public
|
|
@@ -7148,7 +7148,7 @@ export interface ListIngestionJobsResponse {
|
|
|
7148
7148
|
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7149
7149
|
* @public
|
|
7150
7150
|
*/
|
|
7151
|
-
nextToken?: string;
|
|
7151
|
+
nextToken?: string | undefined;
|
|
7152
7152
|
}
|
|
7153
7153
|
/**
|
|
7154
7154
|
* @public
|
|
@@ -7169,12 +7169,12 @@ export interface StartIngestionJobRequest {
|
|
|
7169
7169
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7170
7170
|
* @public
|
|
7171
7171
|
*/
|
|
7172
|
-
clientToken?: string;
|
|
7172
|
+
clientToken?: string | undefined;
|
|
7173
7173
|
/**
|
|
7174
7174
|
* <p>A description of the data ingestion job.</p>
|
|
7175
7175
|
* @public
|
|
7176
7176
|
*/
|
|
7177
|
-
description?: string;
|
|
7177
|
+
description?: string | undefined;
|
|
7178
7178
|
}
|
|
7179
7179
|
/**
|
|
7180
7180
|
* @public
|
|
@@ -7244,7 +7244,7 @@ export interface AssociateAgentKnowledgeBaseRequest {
|
|
|
7244
7244
|
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
7245
7245
|
* @public
|
|
7246
7246
|
*/
|
|
7247
|
-
knowledgeBaseState?: KnowledgeBaseState;
|
|
7247
|
+
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
7248
7248
|
}
|
|
7249
7249
|
/**
|
|
7250
7250
|
* @public
|
|
@@ -7276,7 +7276,7 @@ export interface BedrockEmbeddingModelConfiguration {
|
|
|
7276
7276
|
* <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
|
|
7277
7277
|
* @public
|
|
7278
7278
|
*/
|
|
7279
|
-
dimensions?: number;
|
|
7279
|
+
dimensions?: number | undefined;
|
|
7280
7280
|
}
|
|
7281
7281
|
/**
|
|
7282
7282
|
* <p>The configuration details for the embeddings model.</p>
|
|
@@ -7287,7 +7287,7 @@ export interface EmbeddingModelConfiguration {
|
|
|
7287
7287
|
* <p>The vector configuration details on the Bedrock embeddings model.</p>
|
|
7288
7288
|
* @public
|
|
7289
7289
|
*/
|
|
7290
|
-
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration;
|
|
7290
|
+
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined;
|
|
7291
7291
|
}
|
|
7292
7292
|
/**
|
|
7293
7293
|
* <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
|
|
@@ -7303,7 +7303,7 @@ export interface VectorKnowledgeBaseConfiguration {
|
|
|
7303
7303
|
* <p>The embeddings model configuration details for the vector model used in Knowledge Base.</p>
|
|
7304
7304
|
* @public
|
|
7305
7305
|
*/
|
|
7306
|
-
embeddingModelConfiguration?: EmbeddingModelConfiguration;
|
|
7306
|
+
embeddingModelConfiguration?: EmbeddingModelConfiguration | undefined;
|
|
7307
7307
|
}
|
|
7308
7308
|
/**
|
|
7309
7309
|
* <p>Contains details about the vector embeddings configuration of the knowledge base.</p>
|
|
@@ -7319,7 +7319,7 @@ export interface KnowledgeBaseConfiguration {
|
|
|
7319
7319
|
* <p>Contains details about the model that's used to convert the data source into vector embeddings.</p>
|
|
7320
7320
|
* @public
|
|
7321
7321
|
*/
|
|
7322
|
-
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
|
|
7322
|
+
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined;
|
|
7323
7323
|
}
|
|
7324
7324
|
/**
|
|
7325
7325
|
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
@@ -7381,7 +7381,7 @@ export interface MongoDbAtlasConfiguration {
|
|
|
7381
7381
|
* <p>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</p>
|
|
7382
7382
|
* @public
|
|
7383
7383
|
*/
|
|
7384
|
-
endpointServiceName?: string;
|
|
7384
|
+
endpointServiceName?: string | undefined;
|
|
7385
7385
|
}
|
|
7386
7386
|
/**
|
|
7387
7387
|
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
@@ -7460,7 +7460,7 @@ export interface PineconeConfiguration {
|
|
|
7460
7460
|
* <p>The namespace to be used to write new data to your database.</p>
|
|
7461
7461
|
* @public
|
|
7462
7462
|
*/
|
|
7463
|
-
namespace?: string;
|
|
7463
|
+
namespace?: string | undefined;
|
|
7464
7464
|
/**
|
|
7465
7465
|
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
7466
7466
|
* @public
|
|
@@ -7600,27 +7600,27 @@ export interface StorageConfiguration {
|
|
|
7600
7600
|
* <p>Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.</p>
|
|
7601
7601
|
* @public
|
|
7602
7602
|
*/
|
|
7603
|
-
opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
|
|
7603
|
+
opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
|
|
7604
7604
|
/**
|
|
7605
7605
|
* <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
|
|
7606
7606
|
* @public
|
|
7607
7607
|
*/
|
|
7608
|
-
pineconeConfiguration?: PineconeConfiguration;
|
|
7608
|
+
pineconeConfiguration?: PineconeConfiguration | undefined;
|
|
7609
7609
|
/**
|
|
7610
7610
|
* <p>Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.</p>
|
|
7611
7611
|
* @public
|
|
7612
7612
|
*/
|
|
7613
|
-
redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
|
|
7613
|
+
redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration | undefined;
|
|
7614
7614
|
/**
|
|
7615
7615
|
* <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
|
|
7616
7616
|
* @public
|
|
7617
7617
|
*/
|
|
7618
|
-
rdsConfiguration?: RdsConfiguration;
|
|
7618
|
+
rdsConfiguration?: RdsConfiguration | undefined;
|
|
7619
7619
|
/**
|
|
7620
7620
|
* <p>Contains the storage configuration of the knowledge base in MongoDB Atlas.</p>
|
|
7621
7621
|
* @public
|
|
7622
7622
|
*/
|
|
7623
|
-
mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration;
|
|
7623
|
+
mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
|
|
7624
7624
|
}
|
|
7625
7625
|
/**
|
|
7626
7626
|
* @public
|
|
@@ -7631,7 +7631,7 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
7631
7631
|
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7632
7632
|
* @public
|
|
7633
7633
|
*/
|
|
7634
|
-
clientToken?: string;
|
|
7634
|
+
clientToken?: string | undefined;
|
|
7635
7635
|
/**
|
|
7636
7636
|
* <p>A name for the knowledge base.</p>
|
|
7637
7637
|
* @public
|
|
@@ -7641,7 +7641,7 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
7641
7641
|
* <p>A description of the knowledge base.</p>
|
|
7642
7642
|
* @public
|
|
7643
7643
|
*/
|
|
7644
|
-
description?: string;
|
|
7644
|
+
description?: string | undefined;
|
|
7645
7645
|
/**
|
|
7646
7646
|
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
7647
7647
|
* @public
|
|
@@ -7661,7 +7661,7 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
7661
7661
|
* <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
|
|
7662
7662
|
* @public
|
|
7663
7663
|
*/
|
|
7664
|
-
tags?: Record<string, string
|
|
7664
|
+
tags?: Record<string, string> | undefined;
|
|
7665
7665
|
}
|
|
7666
7666
|
/**
|
|
7667
7667
|
* @public
|
|
@@ -7703,7 +7703,7 @@ export interface KnowledgeBase {
|
|
|
7703
7703
|
* <p>The description of the knowledge base.</p>
|
|
7704
7704
|
* @public
|
|
7705
7705
|
*/
|
|
7706
|
-
description?: string;
|
|
7706
|
+
description?: string | undefined;
|
|
7707
7707
|
/**
|
|
7708
7708
|
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
7709
7709
|
* @public
|
|
@@ -7755,7 +7755,7 @@ export interface KnowledgeBase {
|
|
|
7755
7755
|
* <p>A list of reasons that the API operation on the knowledge base failed.</p>
|
|
7756
7756
|
* @public
|
|
7757
7757
|
*/
|
|
7758
|
-
failureReasons?: string[];
|
|
7758
|
+
failureReasons?: string[] | undefined;
|
|
7759
7759
|
}
|
|
7760
7760
|
/**
|
|
7761
7761
|
* @public
|