@aws-sdk/client-bedrock-agent 3.758.0 → 3.765.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.
- package/dist-cjs/index.js +63 -23
- package/dist-es/models/models_0.js +9 -18
- package/dist-es/models/models_1.js +38 -0
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +8 -2
- package/dist-types/commands/CreateDataSourceCommand.d.ts +18 -0
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +16 -2
- package/dist-types/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +1 -2
- package/dist-types/commands/GetAgentActionGroupCommand.d.ts +4 -1
- package/dist-types/commands/GetDataSourceCommand.d.ts +9 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +8 -1
- package/dist-types/commands/UpdateAgentActionGroupCommand.d.ts +8 -2
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +18 -0
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +16 -2
- package/dist-types/models/models_0.d.ts +177 -160
- package/dist-types/models/models_1.d.ts +207 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +30 -41
- package/dist-types/ts3.4/models/models_1.d.ts +57 -3
- package/package.json +1 -1
|
@@ -343,6 +343,9 @@ export declare namespace FunctionSchema {
|
|
|
343
343
|
export declare const ActionGroupSignature: {
|
|
344
344
|
readonly AMAZON_CODEINTERPRETER: "AMAZON.CodeInterpreter";
|
|
345
345
|
readonly AMAZON_USERINPUT: "AMAZON.UserInput";
|
|
346
|
+
readonly ANTHROPIC_BASH: "ANTHROPIC.Bash";
|
|
347
|
+
readonly ANTHROPIC_COMPUTER: "ANTHROPIC.Computer";
|
|
348
|
+
readonly ANTHROPIC_TEXTEDITOR: "ANTHROPIC.TextEditor";
|
|
346
349
|
};
|
|
347
350
|
/**
|
|
348
351
|
* @public
|
|
@@ -379,12 +382,54 @@ export interface CreateAgentActionGroupRequest {
|
|
|
379
382
|
*/
|
|
380
383
|
description?: string | undefined;
|
|
381
384
|
/**
|
|
382
|
-
* <p>
|
|
383
|
-
* <
|
|
384
|
-
*
|
|
385
|
+
* <p>Specify a built-in or computer use action for this action group. If you specify a value, you must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields empty for this action group. </p>
|
|
386
|
+
* <ul>
|
|
387
|
+
* <li>
|
|
388
|
+
* <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>. </p>
|
|
389
|
+
* </li>
|
|
390
|
+
* <li>
|
|
391
|
+
* <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>.</p>
|
|
392
|
+
* </li>
|
|
393
|
+
* <li>
|
|
394
|
+
* <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p>
|
|
395
|
+
* <important>
|
|
396
|
+
* <p>
|
|
397
|
+
* Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only.
|
|
398
|
+
* When operating computer use functionality, we recommend taking additional security precautions,
|
|
399
|
+
* such as executing computer actions in virtual environments with restricted data access and limited internet connectivity.
|
|
400
|
+
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
401
|
+
* </p>
|
|
402
|
+
* </important>
|
|
403
|
+
* <ul>
|
|
404
|
+
* <li>
|
|
405
|
+
* <p>
|
|
406
|
+
* <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and
|
|
407
|
+
* take screenshots.</p>
|
|
408
|
+
* </li>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>
|
|
411
|
+
* <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p>
|
|
412
|
+
* </li>
|
|
413
|
+
* <li>
|
|
414
|
+
* <p>
|
|
415
|
+
* <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p>
|
|
416
|
+
* </li>
|
|
417
|
+
* </ul>
|
|
418
|
+
* </li>
|
|
419
|
+
* </ul>
|
|
385
420
|
* @public
|
|
386
421
|
*/
|
|
387
422
|
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>The configuration settings for a computer use action.</p>
|
|
425
|
+
* <important>
|
|
426
|
+
* <p>
|
|
427
|
+
* Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
428
|
+
* </p>
|
|
429
|
+
* </important>
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
388
433
|
/**
|
|
389
434
|
* <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
435
|
* @public
|
|
@@ -458,6 +503,16 @@ export interface AgentActionGroup {
|
|
|
458
503
|
* @public
|
|
459
504
|
*/
|
|
460
505
|
parentActionSignature?: ActionGroupSignature | undefined;
|
|
506
|
+
/**
|
|
507
|
+
* <p>The configuration settings for a computer use action.</p>
|
|
508
|
+
* <important>
|
|
509
|
+
* <p>
|
|
510
|
+
* Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
511
|
+
* </p>
|
|
512
|
+
* </important>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
461
516
|
/**
|
|
462
517
|
* <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
518
|
* @public
|
|
@@ -733,11 +788,55 @@ export interface UpdateAgentActionGroupRequest {
|
|
|
733
788
|
*/
|
|
734
789
|
description?: string | undefined;
|
|
735
790
|
/**
|
|
736
|
-
* <p>
|
|
791
|
+
* <p>Update the built-in or computer use action for this action group. If you specify a value, you must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields empty for this action group. </p>
|
|
792
|
+
* <ul>
|
|
793
|
+
* <li>
|
|
794
|
+
* <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>. </p>
|
|
795
|
+
* </li>
|
|
796
|
+
* <li>
|
|
797
|
+
* <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>.</p>
|
|
798
|
+
* </li>
|
|
799
|
+
* <li>
|
|
800
|
+
* <p>To allow your agent to use an Anthropic computer use tool, specify one of the following values. </p>
|
|
801
|
+
* <important>
|
|
802
|
+
* <p>
|
|
803
|
+
* Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only.
|
|
804
|
+
* When operating computer use functionality, we recommend taking additional security precautions,
|
|
805
|
+
* such as executing computer actions in virtual environments with restricted data access and limited internet connectivity.
|
|
806
|
+
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
807
|
+
* </p>
|
|
808
|
+
* </important>
|
|
809
|
+
* <ul>
|
|
810
|
+
* <li>
|
|
811
|
+
* <p>
|
|
812
|
+
* <code>ANTHROPIC.Computer</code> - Gives the agent permission to use the mouse and keyboard and
|
|
813
|
+
* take screenshots.</p>
|
|
814
|
+
* </li>
|
|
815
|
+
* <li>
|
|
816
|
+
* <p>
|
|
817
|
+
* <code>ANTHROPIC.TextEditor</code> - Gives the agent permission to view, create and edit files.</p>
|
|
818
|
+
* </li>
|
|
819
|
+
* <li>
|
|
820
|
+
* <p>
|
|
821
|
+
* <code>ANTHROPIC.Bash</code> - Gives the agent permission to run commands in a bash shell.</p>
|
|
822
|
+
* </li>
|
|
823
|
+
* </ul>
|
|
824
|
+
* </li>
|
|
825
|
+
* </ul>
|
|
737
826
|
* <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
827
|
* @public
|
|
739
828
|
*/
|
|
740
829
|
parentActionGroupSignature?: ActionGroupSignature | undefined;
|
|
830
|
+
/**
|
|
831
|
+
* <p>The configuration settings for a computer use action.</p>
|
|
832
|
+
* <important>
|
|
833
|
+
* <p>
|
|
834
|
+
* Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
|
|
835
|
+
* </p>
|
|
836
|
+
* </important>
|
|
837
|
+
* @public
|
|
838
|
+
*/
|
|
839
|
+
parentActionGroupSignatureParams?: Record<string, string> | undefined;
|
|
741
840
|
/**
|
|
742
841
|
* <p>The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.</p>
|
|
743
842
|
* @public
|
|
@@ -1043,7 +1142,7 @@ export interface PromptConfiguration {
|
|
|
1043
1142
|
*/
|
|
1044
1143
|
inferenceConfiguration?: InferenceConfiguration | undefined;
|
|
1045
1144
|
/**
|
|
1046
|
-
* <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>
|
|
1145
|
+
* <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>OVERRIDDEN</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>
|
|
1047
1146
|
* @public
|
|
1048
1147
|
*/
|
|
1049
1148
|
parserMode?: CreationMode | undefined;
|
|
@@ -3237,6 +3336,73 @@ export interface ChunkingConfiguration {
|
|
|
3237
3336
|
*/
|
|
3238
3337
|
semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
|
|
3239
3338
|
}
|
|
3339
|
+
/**
|
|
3340
|
+
* @public
|
|
3341
|
+
* @enum
|
|
3342
|
+
*/
|
|
3343
|
+
export declare const EnrichmentStrategyMethod: {
|
|
3344
|
+
readonly CHUNK_ENTITY_EXTRACTION: "CHUNK_ENTITY_EXTRACTION";
|
|
3345
|
+
};
|
|
3346
|
+
/**
|
|
3347
|
+
* @public
|
|
3348
|
+
*/
|
|
3349
|
+
export type EnrichmentStrategyMethod = (typeof EnrichmentStrategyMethod)[keyof typeof EnrichmentStrategyMethod];
|
|
3350
|
+
/**
|
|
3351
|
+
* <p>The strategy used for performing context enrichment.</p>
|
|
3352
|
+
* @public
|
|
3353
|
+
*/
|
|
3354
|
+
export interface EnrichmentStrategyConfiguration {
|
|
3355
|
+
/**
|
|
3356
|
+
* <p>The method used for the context enrichment strategy.</p>
|
|
3357
|
+
* @public
|
|
3358
|
+
*/
|
|
3359
|
+
method: EnrichmentStrategyMethod | undefined;
|
|
3360
|
+
}
|
|
3361
|
+
/**
|
|
3362
|
+
* <p>Context enrichment configuration is used to provide additional context to the RAG application
|
|
3363
|
+
* using Amazon Bedrock foundation models.</p>
|
|
3364
|
+
* @public
|
|
3365
|
+
*/
|
|
3366
|
+
export interface BedrockFoundationModelContextEnrichmentConfiguration {
|
|
3367
|
+
/**
|
|
3368
|
+
* <p>The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses
|
|
3369
|
+
* Amazon Bedrock foundation models to perform chunk entity extraction.</p>
|
|
3370
|
+
* @public
|
|
3371
|
+
*/
|
|
3372
|
+
enrichmentStrategyConfiguration: EnrichmentStrategyConfiguration | undefined;
|
|
3373
|
+
/**
|
|
3374
|
+
* <p>The Amazon Resource Name (ARN) of the foundation model used for context enrichment.</p>
|
|
3375
|
+
* @public
|
|
3376
|
+
*/
|
|
3377
|
+
modelArn: string | undefined;
|
|
3378
|
+
}
|
|
3379
|
+
/**
|
|
3380
|
+
* @public
|
|
3381
|
+
* @enum
|
|
3382
|
+
*/
|
|
3383
|
+
export declare const ContextEnrichmentType: {
|
|
3384
|
+
readonly BEDROCK_FOUNDATION_MODEL: "BEDROCK_FOUNDATION_MODEL";
|
|
3385
|
+
};
|
|
3386
|
+
/**
|
|
3387
|
+
* @public
|
|
3388
|
+
*/
|
|
3389
|
+
export type ContextEnrichmentType = (typeof ContextEnrichmentType)[keyof typeof ContextEnrichmentType];
|
|
3390
|
+
/**
|
|
3391
|
+
* <p>Context enrichment configuration is used to provide additional context to the RAG application.</p>
|
|
3392
|
+
* @public
|
|
3393
|
+
*/
|
|
3394
|
+
export interface ContextEnrichmentConfiguration {
|
|
3395
|
+
/**
|
|
3396
|
+
* <p>The method used for context enrichment. It must be Amazon Bedrock foundation models.</p>
|
|
3397
|
+
* @public
|
|
3398
|
+
*/
|
|
3399
|
+
type: ContextEnrichmentType | undefined;
|
|
3400
|
+
/**
|
|
3401
|
+
* <p>The configuration of the Amazon Bedrock foundation model used for context enrichment.</p>
|
|
3402
|
+
* @public
|
|
3403
|
+
*/
|
|
3404
|
+
bedrockFoundationModelConfiguration?: BedrockFoundationModelContextEnrichmentConfiguration | undefined;
|
|
3405
|
+
}
|
|
3240
3406
|
/**
|
|
3241
3407
|
* <p>An Amazon S3 location.</p>
|
|
3242
3408
|
* @public
|
|
@@ -3446,6 +3612,12 @@ export interface VectorIngestionConfiguration {
|
|
|
3446
3612
|
* @public
|
|
3447
3613
|
*/
|
|
3448
3614
|
parsingConfiguration?: ParsingConfiguration | undefined;
|
|
3615
|
+
/**
|
|
3616
|
+
* <p>The context enrichment configuration used for ingestion of the data into the vector
|
|
3617
|
+
* store.</p>
|
|
3618
|
+
* @public
|
|
3619
|
+
*/
|
|
3620
|
+
contextEnrichmentConfiguration?: ContextEnrichmentConfiguration | undefined;
|
|
3449
3621
|
}
|
|
3450
3622
|
/**
|
|
3451
3623
|
* @public
|
|
@@ -7987,161 +8159,6 @@ export interface CustomDocumentIdentifier {
|
|
|
7987
8159
|
*/
|
|
7988
8160
|
id: string | undefined;
|
|
7989
8161
|
}
|
|
7990
|
-
/**
|
|
7991
|
-
* @public
|
|
7992
|
-
* @enum
|
|
7993
|
-
*/
|
|
7994
|
-
export declare const ContentDataSourceType: {
|
|
7995
|
-
readonly CUSTOM: "CUSTOM";
|
|
7996
|
-
readonly S3: "S3";
|
|
7997
|
-
};
|
|
7998
|
-
/**
|
|
7999
|
-
* @public
|
|
8000
|
-
*/
|
|
8001
|
-
export type ContentDataSourceType = (typeof ContentDataSourceType)[keyof typeof ContentDataSourceType];
|
|
8002
|
-
/**
|
|
8003
|
-
* <p>Contains information that identifies the document.</p>
|
|
8004
|
-
* @public
|
|
8005
|
-
*/
|
|
8006
|
-
export interface DocumentIdentifier {
|
|
8007
|
-
/**
|
|
8008
|
-
* <p>The type of data source connected to the knowledge base that contains the document.</p>
|
|
8009
|
-
* @public
|
|
8010
|
-
*/
|
|
8011
|
-
dataSourceType: ContentDataSourceType | undefined;
|
|
8012
|
-
/**
|
|
8013
|
-
* <p>Contains information that identifies the document in an S3 data source.</p>
|
|
8014
|
-
* @public
|
|
8015
|
-
*/
|
|
8016
|
-
s3?: S3Location | undefined;
|
|
8017
|
-
/**
|
|
8018
|
-
* <p>Contains information that identifies the document in a custom data source.</p>
|
|
8019
|
-
* @public
|
|
8020
|
-
*/
|
|
8021
|
-
custom?: CustomDocumentIdentifier | undefined;
|
|
8022
|
-
}
|
|
8023
|
-
/**
|
|
8024
|
-
* @public
|
|
8025
|
-
*/
|
|
8026
|
-
export interface DeleteKnowledgeBaseDocumentsRequest {
|
|
8027
|
-
/**
|
|
8028
|
-
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
8029
|
-
* @public
|
|
8030
|
-
*/
|
|
8031
|
-
knowledgeBaseId: string | undefined;
|
|
8032
|
-
/**
|
|
8033
|
-
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
8034
|
-
* @public
|
|
8035
|
-
*/
|
|
8036
|
-
dataSourceId: string | undefined;
|
|
8037
|
-
/**
|
|
8038
|
-
* <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,
|
|
8039
|
-
* 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>
|
|
8040
|
-
* @public
|
|
8041
|
-
*/
|
|
8042
|
-
clientToken?: string | undefined;
|
|
8043
|
-
/**
|
|
8044
|
-
* <p>A list of objects, each of which contains information to identify a document to delete.</p>
|
|
8045
|
-
* @public
|
|
8046
|
-
*/
|
|
8047
|
-
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
8048
|
-
}
|
|
8049
|
-
/**
|
|
8050
|
-
* @public
|
|
8051
|
-
* @enum
|
|
8052
|
-
*/
|
|
8053
|
-
export declare const DocumentStatus: {
|
|
8054
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
8055
|
-
readonly DELETING: "DELETING";
|
|
8056
|
-
readonly FAILED: "FAILED";
|
|
8057
|
-
readonly IGNORED: "IGNORED";
|
|
8058
|
-
readonly INDEXED: "INDEXED";
|
|
8059
|
-
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
8060
|
-
readonly METADATA_PARTIALLY_INDEXED: "METADATA_PARTIALLY_INDEXED";
|
|
8061
|
-
readonly METADATA_UPDATE_FAILED: "METADATA_UPDATE_FAILED";
|
|
8062
|
-
readonly NOT_FOUND: "NOT_FOUND";
|
|
8063
|
-
readonly PARTIALLY_INDEXED: "PARTIALLY_INDEXED";
|
|
8064
|
-
readonly PENDING: "PENDING";
|
|
8065
|
-
readonly STARTING: "STARTING";
|
|
8066
|
-
};
|
|
8067
|
-
/**
|
|
8068
|
-
* @public
|
|
8069
|
-
*/
|
|
8070
|
-
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
8071
|
-
/**
|
|
8072
|
-
* <p>Contains the details for a document that was ingested or deleted.</p>
|
|
8073
|
-
* @public
|
|
8074
|
-
*/
|
|
8075
|
-
export interface KnowledgeBaseDocumentDetail {
|
|
8076
|
-
/**
|
|
8077
|
-
* <p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>
|
|
8078
|
-
* @public
|
|
8079
|
-
*/
|
|
8080
|
-
knowledgeBaseId: string | undefined;
|
|
8081
|
-
/**
|
|
8082
|
-
* <p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>
|
|
8083
|
-
* @public
|
|
8084
|
-
*/
|
|
8085
|
-
dataSourceId: string | undefined;
|
|
8086
|
-
/**
|
|
8087
|
-
* <p>The ingestion status of the document. The following statuses are possible:</p>
|
|
8088
|
-
* <ul>
|
|
8089
|
-
* <li>
|
|
8090
|
-
* <p>STARTED – You submitted the ingestion job containing the document.</p>
|
|
8091
|
-
* </li>
|
|
8092
|
-
* <li>
|
|
8093
|
-
* <p>PENDING – The document is waiting to be ingested.</p>
|
|
8094
|
-
* </li>
|
|
8095
|
-
* <li>
|
|
8096
|
-
* <p>IN_PROGRESS – The document is being ingested.</p>
|
|
8097
|
-
* </li>
|
|
8098
|
-
* <li>
|
|
8099
|
-
* <p>INDEXED – The document was successfully indexed.</p>
|
|
8100
|
-
* </li>
|
|
8101
|
-
* <li>
|
|
8102
|
-
* <p>PARTIALLY_INDEXED – The document was partially indexed.</p>
|
|
8103
|
-
* </li>
|
|
8104
|
-
* <li>
|
|
8105
|
-
* <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p>
|
|
8106
|
-
* </li>
|
|
8107
|
-
* <li>
|
|
8108
|
-
* <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p>
|
|
8109
|
-
* </li>
|
|
8110
|
-
* <li>
|
|
8111
|
-
* <p>FAILED – The document failed to be ingested.</p>
|
|
8112
|
-
* </li>
|
|
8113
|
-
* <li>
|
|
8114
|
-
* <p>NOT_FOUND – The document wasn't found.</p>
|
|
8115
|
-
* </li>
|
|
8116
|
-
* <li>
|
|
8117
|
-
* <p>IGNORED – The document was ignored during ingestion.</p>
|
|
8118
|
-
* </li>
|
|
8119
|
-
* <li>
|
|
8120
|
-
* <p>DELETING – You submitted the delete job containing the document.</p>
|
|
8121
|
-
* </li>
|
|
8122
|
-
* <li>
|
|
8123
|
-
* <p>DELETE_IN_PROGRESS – The document is being deleted.</p>
|
|
8124
|
-
* </li>
|
|
8125
|
-
* </ul>
|
|
8126
|
-
* @public
|
|
8127
|
-
*/
|
|
8128
|
-
status: DocumentStatus | undefined;
|
|
8129
|
-
/**
|
|
8130
|
-
* <p>Contains information that identifies the document.</p>
|
|
8131
|
-
* @public
|
|
8132
|
-
*/
|
|
8133
|
-
identifier: DocumentIdentifier | undefined;
|
|
8134
|
-
/**
|
|
8135
|
-
* <p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>
|
|
8136
|
-
* @public
|
|
8137
|
-
*/
|
|
8138
|
-
statusReason?: string | undefined;
|
|
8139
|
-
/**
|
|
8140
|
-
* <p>The date and time at which the document was last updated.</p>
|
|
8141
|
-
* @public
|
|
8142
|
-
*/
|
|
8143
|
-
updatedAt?: Date | undefined;
|
|
8144
|
-
}
|
|
8145
8162
|
/**
|
|
8146
8163
|
* @internal
|
|
8147
8164
|
*/
|
|
@@ -1,5 +1,160 @@
|
|
|
1
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import { AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentStatus, AgentVersion, AgentVersionSummary,
|
|
2
|
+
import { AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentStatus, AgentVersion, AgentVersionSummary, CustomDocumentIdentifier, FlowDefinition, FlowValidation, KnowledgeBaseState, PromptInferenceConfiguration, PromptTemplateConfiguration, PromptTemplateType, S3Location } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* @enum
|
|
6
|
+
*/
|
|
7
|
+
export declare const ContentDataSourceType: {
|
|
8
|
+
readonly CUSTOM: "CUSTOM";
|
|
9
|
+
readonly S3: "S3";
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
export type ContentDataSourceType = (typeof ContentDataSourceType)[keyof typeof ContentDataSourceType];
|
|
15
|
+
/**
|
|
16
|
+
* <p>Contains information that identifies the document.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface DocumentIdentifier {
|
|
20
|
+
/**
|
|
21
|
+
* <p>The type of data source connected to the knowledge base that contains the document.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>Contains information that identifies the document in an S3 data source.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
s3?: S3Location | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>Contains information that identifies the document in a custom data source.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
custom?: CustomDocumentIdentifier | undefined;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface DeleteKnowledgeBaseDocumentsRequest {
|
|
40
|
+
/**
|
|
41
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
knowledgeBaseId: string | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
dataSourceId: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <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,
|
|
52
|
+
* 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>
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
clientToken?: string | undefined;
|
|
56
|
+
/**
|
|
57
|
+
* <p>A list of objects, each of which contains information to identify a document to delete.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @public
|
|
64
|
+
* @enum
|
|
65
|
+
*/
|
|
66
|
+
export declare const DocumentStatus: {
|
|
67
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
68
|
+
readonly DELETING: "DELETING";
|
|
69
|
+
readonly FAILED: "FAILED";
|
|
70
|
+
readonly IGNORED: "IGNORED";
|
|
71
|
+
readonly INDEXED: "INDEXED";
|
|
72
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
73
|
+
readonly METADATA_PARTIALLY_INDEXED: "METADATA_PARTIALLY_INDEXED";
|
|
74
|
+
readonly METADATA_UPDATE_FAILED: "METADATA_UPDATE_FAILED";
|
|
75
|
+
readonly NOT_FOUND: "NOT_FOUND";
|
|
76
|
+
readonly PARTIALLY_INDEXED: "PARTIALLY_INDEXED";
|
|
77
|
+
readonly PENDING: "PENDING";
|
|
78
|
+
readonly STARTING: "STARTING";
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
84
|
+
/**
|
|
85
|
+
* <p>Contains the details for a document that was ingested or deleted.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
export interface KnowledgeBaseDocumentDetail {
|
|
89
|
+
/**
|
|
90
|
+
* <p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
knowledgeBaseId: string | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* <p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
dataSourceId: string | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The ingestion status of the document. The following statuses are possible:</p>
|
|
101
|
+
* <ul>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p>STARTED – You submitted the ingestion job containing the document.</p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p>PENDING – The document is waiting to be ingested.</p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>IN_PROGRESS – The document is being ingested.</p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p>INDEXED – The document was successfully indexed.</p>
|
|
113
|
+
* </li>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p>PARTIALLY_INDEXED – The document was partially indexed.</p>
|
|
116
|
+
* </li>
|
|
117
|
+
* <li>
|
|
118
|
+
* <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p>
|
|
122
|
+
* </li>
|
|
123
|
+
* <li>
|
|
124
|
+
* <p>FAILED – The document failed to be ingested.</p>
|
|
125
|
+
* </li>
|
|
126
|
+
* <li>
|
|
127
|
+
* <p>NOT_FOUND – The document wasn't found.</p>
|
|
128
|
+
* </li>
|
|
129
|
+
* <li>
|
|
130
|
+
* <p>IGNORED – The document was ignored during ingestion.</p>
|
|
131
|
+
* </li>
|
|
132
|
+
* <li>
|
|
133
|
+
* <p>DELETING – You submitted the delete job containing the document.</p>
|
|
134
|
+
* </li>
|
|
135
|
+
* <li>
|
|
136
|
+
* <p>DELETE_IN_PROGRESS – The document is being deleted.</p>
|
|
137
|
+
* </li>
|
|
138
|
+
* </ul>
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
status: DocumentStatus | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* <p>Contains information that identifies the document.</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
identifier: DocumentIdentifier | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* <p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
statusReason?: string | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* <p>The date and time at which the document was last updated.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
updatedAt?: Date | undefined;
|
|
157
|
+
}
|
|
3
158
|
/**
|
|
4
159
|
* @public
|
|
5
160
|
*/
|
|
@@ -1025,6 +1180,41 @@ export interface MongoDbAtlasConfiguration {
|
|
|
1025
1180
|
*/
|
|
1026
1181
|
endpointServiceName?: string | undefined;
|
|
1027
1182
|
}
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
export interface NeptuneAnalyticsFieldMapping {
|
|
1188
|
+
/**
|
|
1189
|
+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text
|
|
1190
|
+
* is split according to the chunking strategy you choose.</p>
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
textField: string | undefined;
|
|
1194
|
+
/**
|
|
1195
|
+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
metadataField: string | undefined;
|
|
1199
|
+
}
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>Contains details about the storage configuration of the knowledge base in
|
|
1202
|
+
* Amazon Neptune Analytics. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html">Create a vector index
|
|
1203
|
+
* in Amazon Neptune Analytics</a>.</p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
export interface NeptuneAnalyticsConfiguration {
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>The Amazon Resource Name (ARN) of the Neptune Analytics vector store.</p>
|
|
1209
|
+
* @public
|
|
1210
|
+
*/
|
|
1211
|
+
graphArn: string | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
1214
|
+
* @public
|
|
1215
|
+
*/
|
|
1216
|
+
fieldMapping: NeptuneAnalyticsFieldMapping | undefined;
|
|
1217
|
+
}
|
|
1028
1218
|
/**
|
|
1029
1219
|
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
1030
1220
|
* @public
|
|
@@ -1219,6 +1409,7 @@ export interface RedisEnterpriseCloudConfiguration {
|
|
|
1219
1409
|
*/
|
|
1220
1410
|
export declare const KnowledgeBaseStorageType: {
|
|
1221
1411
|
readonly MONGO_DB_ATLAS: "MONGO_DB_ATLAS";
|
|
1412
|
+
readonly NEPTUNE_ANALYTICS: "NEPTUNE_ANALYTICS";
|
|
1222
1413
|
readonly OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS";
|
|
1223
1414
|
readonly PINECONE: "PINECONE";
|
|
1224
1415
|
readonly RDS: "RDS";
|
|
@@ -1263,6 +1454,13 @@ export interface StorageConfiguration {
|
|
|
1263
1454
|
* @public
|
|
1264
1455
|
*/
|
|
1265
1456
|
mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined;
|
|
1457
|
+
/**
|
|
1458
|
+
* <p>Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information,
|
|
1459
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html">Create a
|
|
1460
|
+
* vector index in Amazon Neptune Analytics.</a>.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
neptuneAnalyticsConfiguration?: NeptuneAnalyticsConfiguration | undefined;
|
|
1266
1464
|
}
|
|
1267
1465
|
/**
|
|
1268
1466
|
* @public
|
|
@@ -2489,6 +2687,14 @@ export declare const SqlKnowledgeBaseConfigurationFilterSensitiveLog: (obj: SqlK
|
|
|
2489
2687
|
* @internal
|
|
2490
2688
|
*/
|
|
2491
2689
|
export declare const KnowledgeBaseConfigurationFilterSensitiveLog: (obj: KnowledgeBaseConfiguration) => any;
|
|
2690
|
+
/**
|
|
2691
|
+
* @internal
|
|
2692
|
+
*/
|
|
2693
|
+
export declare const NeptuneAnalyticsConfigurationFilterSensitiveLog: (obj: NeptuneAnalyticsConfiguration) => any;
|
|
2694
|
+
/**
|
|
2695
|
+
* @internal
|
|
2696
|
+
*/
|
|
2697
|
+
export declare const StorageConfigurationFilterSensitiveLog: (obj: StorageConfiguration) => any;
|
|
2492
2698
|
/**
|
|
2493
2699
|
* @internal
|
|
2494
2700
|
*/
|
|
@@ -5,8 +5,10 @@ import {
|
|
|
5
5
|
ServiceInputTypes,
|
|
6
6
|
ServiceOutputTypes,
|
|
7
7
|
} from "../BedrockAgentClient";
|
|
8
|
-
import {
|
|
9
|
-
|
|
8
|
+
import {
|
|
9
|
+
DeleteKnowledgeBaseDocumentsRequest,
|
|
10
|
+
DeleteKnowledgeBaseDocumentsResponse,
|
|
11
|
+
} from "../models/models_1";
|
|
10
12
|
export { __MetadataBearer };
|
|
11
13
|
export { $Command };
|
|
12
14
|
export interface DeleteKnowledgeBaseDocumentsCommandInput
|