aws-sdk 2.1657.0 → 2.1658.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/README.md +1 -1
- package/apis/batch-2016-08-10.min.json +62 -52
- package/apis/bedrock-2023-04-20.min.json +140 -86
- package/apis/bedrock-agent-2023-06-05.min.json +1991 -171
- package/apis/bedrock-agent-2023-06-05.paginators.json +24 -0
- package/apis/bedrock-agent-runtime-2023-07-26.min.json +642 -216
- package/apis/bedrock-agent-runtime-2023-07-26.paginators.json +6 -0
- package/apis/bedrock-runtime-2023-09-30.min.json +329 -192
- package/apis/ec2-2016-11-15.min.json +79 -67
- package/apis/glue-2017-03-31.min.json +407 -368
- package/apis/groundstation-2019-05-23.min.json +7 -1
- package/apis/license-manager-linux-subscriptions-2018-05-10.min.json +236 -16
- package/apis/license-manager-linux-subscriptions-2018-05-10.paginators.json +6 -0
- package/apis/mediaconnect-2018-11-14.min.json +106 -94
- package/clients/batch.d.ts +12 -0
- package/clients/bedrock.d.ts +63 -14
- package/clients/bedrockagent.d.ts +2172 -171
- package/clients/bedrockagentruntime.d.ts +396 -11
- package/clients/bedrockruntime.d.ts +149 -6
- package/clients/ec2.d.ts +28 -3
- package/clients/glue.d.ts +48 -1
- package/clients/licensemanagerlinuxsubscriptions.d.ts +249 -10
- package/clients/mediaconnect.d.ts +13 -0
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +14 -14
- package/dist/aws-sdk.js +82 -70
- package/dist/aws-sdk.min.js +76 -76
- package/lib/core.js +1 -1
- package/package.json +1 -1
@@ -20,19 +20,19 @@ declare class BedrockAgent extends Service {
|
|
20
20
|
*/
|
21
21
|
associateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
|
23
|
+
* Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
|
24
24
|
*/
|
25
25
|
createAgent(params: BedrockAgent.Types.CreateAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
|
27
|
+
* Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
|
28
28
|
*/
|
29
29
|
createAgent(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
|
30
30
|
/**
|
31
|
-
* Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
31
|
+
* Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
32
32
|
*/
|
33
33
|
createAgentActionGroup(params: BedrockAgent.Types.CreateAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
|
34
34
|
/**
|
35
|
-
* Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
35
|
+
* Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
36
36
|
*/
|
37
37
|
createAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
|
38
38
|
/**
|
@@ -44,13 +44,37 @@ declare class BedrockAgent extends Service {
|
|
44
44
|
*/
|
45
45
|
createAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentAliasResponse) => void): Request<BedrockAgent.Types.CreateAgentAliasResponse, AWSError>;
|
46
46
|
/**
|
47
|
-
*
|
47
|
+
* Creates a data source connector for a knowledge base. You can't change the chunkingConfiguration after you create the data source connector.
|
48
48
|
*/
|
49
49
|
createDataSource(params: BedrockAgent.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
|
50
50
|
/**
|
51
|
-
*
|
51
|
+
* Creates a data source connector for a knowledge base. You can't change the chunkingConfiguration after you create the data source connector.
|
52
52
|
*/
|
53
53
|
createDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
|
54
|
+
/**
|
55
|
+
* Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
56
|
+
*/
|
57
|
+
createFlow(params: BedrockAgent.Types.CreateFlowRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowResponse) => void): Request<BedrockAgent.Types.CreateFlowResponse, AWSError>;
|
58
|
+
/**
|
59
|
+
* Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
60
|
+
*/
|
61
|
+
createFlow(callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowResponse) => void): Request<BedrockAgent.Types.CreateFlowResponse, AWSError>;
|
62
|
+
/**
|
63
|
+
* Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
64
|
+
*/
|
65
|
+
createFlowAlias(params: BedrockAgent.Types.CreateFlowAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowAliasResponse) => void): Request<BedrockAgent.Types.CreateFlowAliasResponse, AWSError>;
|
66
|
+
/**
|
67
|
+
* Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
68
|
+
*/
|
69
|
+
createFlowAlias(callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowAliasResponse) => void): Request<BedrockAgent.Types.CreateFlowAliasResponse, AWSError>;
|
70
|
+
/**
|
71
|
+
* Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
72
|
+
*/
|
73
|
+
createFlowVersion(params: BedrockAgent.Types.CreateFlowVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowVersionResponse) => void): Request<BedrockAgent.Types.CreateFlowVersionResponse, AWSError>;
|
74
|
+
/**
|
75
|
+
* Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
76
|
+
*/
|
77
|
+
createFlowVersion(callback?: (err: AWSError, data: BedrockAgent.Types.CreateFlowVersionResponse) => void): Request<BedrockAgent.Types.CreateFlowVersionResponse, AWSError>;
|
54
78
|
/**
|
55
79
|
* Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
|
56
80
|
*/
|
@@ -59,6 +83,22 @@ declare class BedrockAgent extends Service {
|
|
59
83
|
* Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
|
60
84
|
*/
|
61
85
|
createKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.CreateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.CreateKnowledgeBaseResponse, AWSError>;
|
86
|
+
/**
|
87
|
+
* Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
88
|
+
*/
|
89
|
+
createPrompt(params: BedrockAgent.Types.CreatePromptRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreatePromptResponse) => void): Request<BedrockAgent.Types.CreatePromptResponse, AWSError>;
|
90
|
+
/**
|
91
|
+
* Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
92
|
+
*/
|
93
|
+
createPrompt(callback?: (err: AWSError, data: BedrockAgent.Types.CreatePromptResponse) => void): Request<BedrockAgent.Types.CreatePromptResponse, AWSError>;
|
94
|
+
/**
|
95
|
+
* Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
|
96
|
+
*/
|
97
|
+
createPromptVersion(params: BedrockAgent.Types.CreatePromptVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreatePromptVersionResponse) => void): Request<BedrockAgent.Types.CreatePromptVersionResponse, AWSError>;
|
98
|
+
/**
|
99
|
+
* Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
|
100
|
+
*/
|
101
|
+
createPromptVersion(callback?: (err: AWSError, data: BedrockAgent.Types.CreatePromptVersionResponse) => void): Request<BedrockAgent.Types.CreatePromptVersionResponse, AWSError>;
|
62
102
|
/**
|
63
103
|
* Deletes an agent.
|
64
104
|
*/
|
@@ -99,6 +139,30 @@ declare class BedrockAgent extends Service {
|
|
99
139
|
* Deletes a data source from a knowledge base.
|
100
140
|
*/
|
101
141
|
deleteDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteDataSourceResponse) => void): Request<BedrockAgent.Types.DeleteDataSourceResponse, AWSError>;
|
142
|
+
/**
|
143
|
+
* Deletes a flow.
|
144
|
+
*/
|
145
|
+
deleteFlow(params: BedrockAgent.Types.DeleteFlowRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowResponse) => void): Request<BedrockAgent.Types.DeleteFlowResponse, AWSError>;
|
146
|
+
/**
|
147
|
+
* Deletes a flow.
|
148
|
+
*/
|
149
|
+
deleteFlow(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowResponse) => void): Request<BedrockAgent.Types.DeleteFlowResponse, AWSError>;
|
150
|
+
/**
|
151
|
+
* Deletes an alias of a flow.
|
152
|
+
*/
|
153
|
+
deleteFlowAlias(params: BedrockAgent.Types.DeleteFlowAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowAliasResponse) => void): Request<BedrockAgent.Types.DeleteFlowAliasResponse, AWSError>;
|
154
|
+
/**
|
155
|
+
* Deletes an alias of a flow.
|
156
|
+
*/
|
157
|
+
deleteFlowAlias(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowAliasResponse) => void): Request<BedrockAgent.Types.DeleteFlowAliasResponse, AWSError>;
|
158
|
+
/**
|
159
|
+
* Deletes a version of a flow.
|
160
|
+
*/
|
161
|
+
deleteFlowVersion(params: BedrockAgent.Types.DeleteFlowVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowVersionResponse) => void): Request<BedrockAgent.Types.DeleteFlowVersionResponse, AWSError>;
|
162
|
+
/**
|
163
|
+
* Deletes a version of a flow.
|
164
|
+
*/
|
165
|
+
deleteFlowVersion(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteFlowVersionResponse) => void): Request<BedrockAgent.Types.DeleteFlowVersionResponse, AWSError>;
|
102
166
|
/**
|
103
167
|
* Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
|
104
168
|
*/
|
@@ -107,6 +171,14 @@ declare class BedrockAgent extends Service {
|
|
107
171
|
* Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
|
108
172
|
*/
|
109
173
|
deleteKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DeleteKnowledgeBaseResponse, AWSError>;
|
174
|
+
/**
|
175
|
+
* Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
|
176
|
+
*/
|
177
|
+
deletePrompt(params: BedrockAgent.Types.DeletePromptRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeletePromptResponse) => void): Request<BedrockAgent.Types.DeletePromptResponse, AWSError>;
|
178
|
+
/**
|
179
|
+
* Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
|
180
|
+
*/
|
181
|
+
deletePrompt(callback?: (err: AWSError, data: BedrockAgent.Types.DeletePromptResponse) => void): Request<BedrockAgent.Types.DeletePromptResponse, AWSError>;
|
110
182
|
/**
|
111
183
|
* Disassociates a knowledge base from an agent.
|
112
184
|
*/
|
@@ -163,6 +235,30 @@ declare class BedrockAgent extends Service {
|
|
163
235
|
* Gets information about a data source.
|
164
236
|
*/
|
165
237
|
getDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.GetDataSourceResponse) => void): Request<BedrockAgent.Types.GetDataSourceResponse, AWSError>;
|
238
|
+
/**
|
239
|
+
* Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
240
|
+
*/
|
241
|
+
getFlow(params: BedrockAgent.Types.GetFlowRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowResponse) => void): Request<BedrockAgent.Types.GetFlowResponse, AWSError>;
|
242
|
+
/**
|
243
|
+
* Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
244
|
+
*/
|
245
|
+
getFlow(callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowResponse) => void): Request<BedrockAgent.Types.GetFlowResponse, AWSError>;
|
246
|
+
/**
|
247
|
+
* Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
248
|
+
*/
|
249
|
+
getFlowAlias(params: BedrockAgent.Types.GetFlowAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowAliasResponse) => void): Request<BedrockAgent.Types.GetFlowAliasResponse, AWSError>;
|
250
|
+
/**
|
251
|
+
* Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
252
|
+
*/
|
253
|
+
getFlowAlias(callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowAliasResponse) => void): Request<BedrockAgent.Types.GetFlowAliasResponse, AWSError>;
|
254
|
+
/**
|
255
|
+
* Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
256
|
+
*/
|
257
|
+
getFlowVersion(params: BedrockAgent.Types.GetFlowVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowVersionResponse) => void): Request<BedrockAgent.Types.GetFlowVersionResponse, AWSError>;
|
258
|
+
/**
|
259
|
+
* Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
260
|
+
*/
|
261
|
+
getFlowVersion(callback?: (err: AWSError, data: BedrockAgent.Types.GetFlowVersionResponse) => void): Request<BedrockAgent.Types.GetFlowVersionResponse, AWSError>;
|
166
262
|
/**
|
167
263
|
* Gets information about a ingestion job, in which a data source is added to a knowledge base.
|
168
264
|
*/
|
@@ -179,6 +275,14 @@ declare class BedrockAgent extends Service {
|
|
179
275
|
* Gets information about a knoweldge base.
|
180
276
|
*/
|
181
277
|
getKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.GetKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetKnowledgeBaseResponse, AWSError>;
|
278
|
+
/**
|
279
|
+
* Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
|
280
|
+
*/
|
281
|
+
getPrompt(params: BedrockAgent.Types.GetPromptRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetPromptResponse) => void): Request<BedrockAgent.Types.GetPromptResponse, AWSError>;
|
282
|
+
/**
|
283
|
+
* Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
|
284
|
+
*/
|
285
|
+
getPrompt(callback?: (err: AWSError, data: BedrockAgent.Types.GetPromptResponse) => void): Request<BedrockAgent.Types.GetPromptResponse, AWSError>;
|
182
286
|
/**
|
183
287
|
* Lists the action groups for an agent and information about each one.
|
184
288
|
*/
|
@@ -227,6 +331,30 @@ declare class BedrockAgent extends Service {
|
|
227
331
|
* Lists the data sources in a knowledge base and information about each one.
|
228
332
|
*/
|
229
333
|
listDataSources(callback?: (err: AWSError, data: BedrockAgent.Types.ListDataSourcesResponse) => void): Request<BedrockAgent.Types.ListDataSourcesResponse, AWSError>;
|
334
|
+
/**
|
335
|
+
* Returns a list of aliases for a flow.
|
336
|
+
*/
|
337
|
+
listFlowAliases(params: BedrockAgent.Types.ListFlowAliasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowAliasesResponse) => void): Request<BedrockAgent.Types.ListFlowAliasesResponse, AWSError>;
|
338
|
+
/**
|
339
|
+
* Returns a list of aliases for a flow.
|
340
|
+
*/
|
341
|
+
listFlowAliases(callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowAliasesResponse) => void): Request<BedrockAgent.Types.ListFlowAliasesResponse, AWSError>;
|
342
|
+
/**
|
343
|
+
* Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
344
|
+
*/
|
345
|
+
listFlowVersions(params: BedrockAgent.Types.ListFlowVersionsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowVersionsResponse) => void): Request<BedrockAgent.Types.ListFlowVersionsResponse, AWSError>;
|
346
|
+
/**
|
347
|
+
* Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
348
|
+
*/
|
349
|
+
listFlowVersions(callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowVersionsResponse) => void): Request<BedrockAgent.Types.ListFlowVersionsResponse, AWSError>;
|
350
|
+
/**
|
351
|
+
* Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
352
|
+
*/
|
353
|
+
listFlows(params: BedrockAgent.Types.ListFlowsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowsResponse) => void): Request<BedrockAgent.Types.ListFlowsResponse, AWSError>;
|
354
|
+
/**
|
355
|
+
* Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
356
|
+
*/
|
357
|
+
listFlows(callback?: (err: AWSError, data: BedrockAgent.Types.ListFlowsResponse) => void): Request<BedrockAgent.Types.ListFlowsResponse, AWSError>;
|
230
358
|
/**
|
231
359
|
* Lists the ingestion jobs for a data source and information about each of them.
|
232
360
|
*/
|
@@ -243,6 +371,14 @@ declare class BedrockAgent extends Service {
|
|
243
371
|
* Lists the knowledge bases in an account and information about each of them.
|
244
372
|
*/
|
245
373
|
listKnowledgeBases(callback?: (err: AWSError, data: BedrockAgent.Types.ListKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListKnowledgeBasesResponse, AWSError>;
|
374
|
+
/**
|
375
|
+
* Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
|
376
|
+
*/
|
377
|
+
listPrompts(params: BedrockAgent.Types.ListPromptsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListPromptsResponse) => void): Request<BedrockAgent.Types.ListPromptsResponse, AWSError>;
|
378
|
+
/**
|
379
|
+
* Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
|
380
|
+
*/
|
381
|
+
listPrompts(callback?: (err: AWSError, data: BedrockAgent.Types.ListPromptsResponse) => void): Request<BedrockAgent.Types.ListPromptsResponse, AWSError>;
|
246
382
|
/**
|
247
383
|
* List all the tags for the resource you specify.
|
248
384
|
*/
|
@@ -259,6 +395,14 @@ declare class BedrockAgent extends Service {
|
|
259
395
|
* Creates a DRAFT version of the agent that can be used for internal testing.
|
260
396
|
*/
|
261
397
|
prepareAgent(callback?: (err: AWSError, data: BedrockAgent.Types.PrepareAgentResponse) => void): Request<BedrockAgent.Types.PrepareAgentResponse, AWSError>;
|
398
|
+
/**
|
399
|
+
* Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
400
|
+
*/
|
401
|
+
prepareFlow(params: BedrockAgent.Types.PrepareFlowRequest, callback?: (err: AWSError, data: BedrockAgent.Types.PrepareFlowResponse) => void): Request<BedrockAgent.Types.PrepareFlowResponse, AWSError>;
|
402
|
+
/**
|
403
|
+
* Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
404
|
+
*/
|
405
|
+
prepareFlow(callback?: (err: AWSError, data: BedrockAgent.Types.PrepareFlowResponse) => void): Request<BedrockAgent.Types.PrepareFlowResponse, AWSError>;
|
262
406
|
/**
|
263
407
|
* Begins an ingestion job, in which a data source is added to a knowledge base.
|
264
408
|
*/
|
@@ -316,13 +460,29 @@ declare class BedrockAgent extends Service {
|
|
316
460
|
*/
|
317
461
|
updateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse, AWSError>;
|
318
462
|
/**
|
319
|
-
* Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
|
463
|
+
* Updates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
|
320
464
|
*/
|
321
465
|
updateDataSource(params: BedrockAgent.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
|
322
466
|
/**
|
323
|
-
* Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
|
467
|
+
* Updates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
|
324
468
|
*/
|
325
469
|
updateDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
|
470
|
+
/**
|
471
|
+
* Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
472
|
+
*/
|
473
|
+
updateFlow(params: BedrockAgent.Types.UpdateFlowRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateFlowResponse) => void): Request<BedrockAgent.Types.UpdateFlowResponse, AWSError>;
|
474
|
+
/**
|
475
|
+
* Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
476
|
+
*/
|
477
|
+
updateFlow(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateFlowResponse) => void): Request<BedrockAgent.Types.UpdateFlowResponse, AWSError>;
|
478
|
+
/**
|
479
|
+
* Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
480
|
+
*/
|
481
|
+
updateFlowAlias(params: BedrockAgent.Types.UpdateFlowAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateFlowAliasResponse) => void): Request<BedrockAgent.Types.UpdateFlowAliasResponse, AWSError>;
|
482
|
+
/**
|
483
|
+
* Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
|
484
|
+
*/
|
485
|
+
updateFlowAlias(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateFlowAliasResponse) => void): Request<BedrockAgent.Types.UpdateFlowAliasResponse, AWSError>;
|
326
486
|
/**
|
327
487
|
* Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
|
328
488
|
*/
|
@@ -331,6 +491,14 @@ declare class BedrockAgent extends Service {
|
|
331
491
|
* Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
|
332
492
|
*/
|
333
493
|
updateKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateKnowledgeBaseResponse, AWSError>;
|
494
|
+
/**
|
495
|
+
* Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
|
496
|
+
*/
|
497
|
+
updatePrompt(params: BedrockAgent.Types.UpdatePromptRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdatePromptResponse) => void): Request<BedrockAgent.Types.UpdatePromptResponse, AWSError>;
|
498
|
+
/**
|
499
|
+
* Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
|
500
|
+
*/
|
501
|
+
updatePrompt(callback?: (err: AWSError, data: BedrockAgent.Types.UpdatePromptResponse) => void): Request<BedrockAgent.Types.UpdatePromptResponse, AWSError>;
|
334
502
|
}
|
335
503
|
declare namespace BedrockAgent {
|
336
504
|
export interface APISchema {
|
@@ -353,7 +521,7 @@ declare namespace BedrockAgent {
|
|
353
521
|
*/
|
354
522
|
lambda?: LambdaArn;
|
355
523
|
}
|
356
|
-
export type ActionGroupSignature = "AMAZON.UserInput"|string;
|
524
|
+
export type ActionGroupSignature = "AMAZON.UserInput"|"AMAZON.CodeInterpreter"|string;
|
357
525
|
export type ActionGroupState = "ENABLED"|"DISABLED"|string;
|
358
526
|
export type ActionGroupSummaries = ActionGroupSummary[];
|
359
527
|
export interface ActionGroupSummary {
|
@@ -428,7 +596,7 @@ declare namespace BedrockAgent {
|
|
428
596
|
*/
|
429
597
|
foundationModel?: ModelIdentifier;
|
430
598
|
/**
|
431
|
-
*
|
599
|
+
* Details about the guardrail associated with the agent.
|
432
600
|
*/
|
433
601
|
guardrailConfiguration?: GuardrailConfiguration;
|
434
602
|
/**
|
@@ -439,6 +607,10 @@ declare namespace BedrockAgent {
|
|
439
607
|
* Instructions that tell the agent what it should do and how it should interact with users.
|
440
608
|
*/
|
441
609
|
instruction?: Instruction;
|
610
|
+
/**
|
611
|
+
* Contains memory configuration for the agent.
|
612
|
+
*/
|
613
|
+
memoryConfiguration?: MemoryConfiguration;
|
442
614
|
/**
|
443
615
|
* The time at which the agent was last prepared.
|
444
616
|
*/
|
@@ -621,6 +793,12 @@ declare namespace BedrockAgent {
|
|
621
793
|
updatedAt: DateTimestamp;
|
622
794
|
}
|
623
795
|
export type AgentArn = string;
|
796
|
+
export interface AgentFlowNodeConfiguration {
|
797
|
+
/**
|
798
|
+
* The Amazon Resource Name (ARN) of the alias of the agent to invoke.
|
799
|
+
*/
|
800
|
+
agentAliasArn: AgentAliasArn;
|
801
|
+
}
|
624
802
|
export interface AgentKnowledgeBase {
|
625
803
|
/**
|
626
804
|
* The unique identifier of the agent with which the knowledge base is associated.
|
@@ -691,7 +869,7 @@ declare namespace BedrockAgent {
|
|
691
869
|
*/
|
692
870
|
description?: Description;
|
693
871
|
/**
|
694
|
-
*
|
872
|
+
* Details about the guardrail associated with the agent.
|
695
873
|
*/
|
696
874
|
guardrailConfiguration?: GuardrailConfiguration;
|
697
875
|
/**
|
@@ -745,7 +923,7 @@ declare namespace BedrockAgent {
|
|
745
923
|
*/
|
746
924
|
foundationModel?: ModelIdentifier;
|
747
925
|
/**
|
748
|
-
*
|
926
|
+
* Details about the guardrail associated with the agent.
|
749
927
|
*/
|
750
928
|
guardrailConfiguration?: GuardrailConfiguration;
|
751
929
|
/**
|
@@ -756,6 +934,10 @@ declare namespace BedrockAgent {
|
|
756
934
|
* The instructions provided to the agent.
|
757
935
|
*/
|
758
936
|
instruction?: Instruction;
|
937
|
+
/**
|
938
|
+
* Contains details of the memory configuration on the version of the agent.
|
939
|
+
*/
|
940
|
+
memoryConfiguration?: MemoryConfiguration;
|
759
941
|
/**
|
760
942
|
* Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
|
761
943
|
*/
|
@@ -796,7 +978,7 @@ declare namespace BedrockAgent {
|
|
796
978
|
*/
|
797
979
|
description?: Description;
|
798
980
|
/**
|
799
|
-
*
|
981
|
+
* Details about the guardrail associated with the agent.
|
800
982
|
*/
|
801
983
|
guardrailConfiguration?: GuardrailConfiguration;
|
802
984
|
/**
|
@@ -840,21 +1022,95 @@ declare namespace BedrockAgent {
|
|
840
1022
|
*/
|
841
1023
|
dimensions?: Dimensions;
|
842
1024
|
}
|
1025
|
+
export interface BedrockFoundationModelConfiguration {
|
1026
|
+
/**
|
1027
|
+
* The model's ARN.
|
1028
|
+
*/
|
1029
|
+
modelArn: BedrockModelArn;
|
1030
|
+
/**
|
1031
|
+
* Instructions for interpreting the contents of a document.
|
1032
|
+
*/
|
1033
|
+
parsingPrompt?: ParsingPrompt;
|
1034
|
+
}
|
1035
|
+
export type BedrockModelArn = string;
|
843
1036
|
export type Boolean = boolean;
|
844
1037
|
export type BucketOwnerAccountId = string;
|
845
1038
|
export interface ChunkingConfiguration {
|
846
1039
|
/**
|
847
|
-
* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration. NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
|
1040
|
+
* Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration. HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing. NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
|
848
1041
|
*/
|
849
1042
|
chunkingStrategy: ChunkingStrategy;
|
850
1043
|
/**
|
851
1044
|
* Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
|
852
1045
|
*/
|
853
1046
|
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
|
1047
|
+
/**
|
1048
|
+
* Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
|
1049
|
+
*/
|
1050
|
+
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration;
|
1051
|
+
/**
|
1052
|
+
* Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
|
1053
|
+
*/
|
1054
|
+
semanticChunkingConfiguration?: SemanticChunkingConfiguration;
|
854
1055
|
}
|
855
|
-
export type ChunkingStrategy = "FIXED_SIZE"|"NONE"|string;
|
1056
|
+
export type ChunkingStrategy = "FIXED_SIZE"|"NONE"|"HIERARCHICAL"|"SEMANTIC"|string;
|
856
1057
|
export type ClientToken = string;
|
1058
|
+
export interface CollectorFlowNodeConfiguration {
|
1059
|
+
}
|
857
1060
|
export type ColumnName = string;
|
1061
|
+
export interface ConditionFlowNodeConfiguration {
|
1062
|
+
/**
|
1063
|
+
* An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
|
1064
|
+
*/
|
1065
|
+
conditions: FlowConditions;
|
1066
|
+
}
|
1067
|
+
export type ConfluenceAuthType = "BASIC"|"OAUTH2_CLIENT_CREDENTIALS"|string;
|
1068
|
+
export interface ConfluenceCrawlerConfiguration {
|
1069
|
+
/**
|
1070
|
+
* The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.
|
1071
|
+
*/
|
1072
|
+
filterConfiguration?: CrawlFilterConfiguration;
|
1073
|
+
}
|
1074
|
+
export interface ConfluenceDataSourceConfiguration {
|
1075
|
+
/**
|
1076
|
+
* The configuration of the Confluence content. For example, configuring specific types of Confluence content.
|
1077
|
+
*/
|
1078
|
+
crawlerConfiguration?: ConfluenceCrawlerConfiguration;
|
1079
|
+
/**
|
1080
|
+
* The endpoint information to connect to your Confluence data source.
|
1081
|
+
*/
|
1082
|
+
sourceConfiguration: ConfluenceSourceConfiguration;
|
1083
|
+
}
|
1084
|
+
export type ConfluenceHostType = "SAAS"|string;
|
1085
|
+
export interface ConfluenceSourceConfiguration {
|
1086
|
+
/**
|
1087
|
+
* The supported authentication type to authenticate and connect to your Confluence instance.
|
1088
|
+
*/
|
1089
|
+
authType: ConfluenceAuthType;
|
1090
|
+
/**
|
1091
|
+
* The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.
|
1092
|
+
*/
|
1093
|
+
credentialsSecretArn: SecretArn;
|
1094
|
+
/**
|
1095
|
+
* The supported host type, whether online/cloud or server/on-premises.
|
1096
|
+
*/
|
1097
|
+
hostType: ConfluenceHostType;
|
1098
|
+
/**
|
1099
|
+
* The Confluence host URL or instance URL.
|
1100
|
+
*/
|
1101
|
+
hostUrl: HttpsUrl;
|
1102
|
+
}
|
1103
|
+
export interface CrawlFilterConfiguration {
|
1104
|
+
/**
|
1105
|
+
* The configuration of filtering certain objects or content types of the data source.
|
1106
|
+
*/
|
1107
|
+
patternObjectFilter?: PatternObjectFilterConfiguration;
|
1108
|
+
/**
|
1109
|
+
* The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.
|
1110
|
+
*/
|
1111
|
+
type: CrawlFilterConfigurationType;
|
1112
|
+
}
|
1113
|
+
export type CrawlFilterConfigurationType = "PATTERN"|string;
|
858
1114
|
export interface CreateAgentActionGroupRequest {
|
859
1115
|
/**
|
860
1116
|
* 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.
|
@@ -893,7 +1149,7 @@ declare namespace BedrockAgent {
|
|
893
1149
|
*/
|
894
1150
|
functionSchema?: FunctionSchema;
|
895
1151
|
/**
|
896
|
-
* To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
1152
|
+
* To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. 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 Observation reprompting the user for more information.
|
897
1153
|
*/
|
898
1154
|
parentActionGroupSignature?: ActionGroupSignature;
|
899
1155
|
}
|
@@ -972,6 +1228,10 @@ declare namespace BedrockAgent {
|
|
972
1228
|
* Instructions that tell the agent what it should do and how it should interact with users.
|
973
1229
|
*/
|
974
1230
|
instruction?: Instruction;
|
1231
|
+
/**
|
1232
|
+
* Contains the details of the memory configured for the agent.
|
1233
|
+
*/
|
1234
|
+
memoryConfiguration?: MemoryConfiguration;
|
975
1235
|
/**
|
976
1236
|
* Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
|
977
1237
|
*/
|
@@ -993,11 +1253,11 @@ declare namespace BedrockAgent {
|
|
993
1253
|
*/
|
994
1254
|
clientToken?: ClientToken;
|
995
1255
|
/**
|
996
|
-
* The data deletion policy
|
1256
|
+
* The data deletion policy for the data source. You can set the data deletion policy to: DELETE: Deletes all underlying data belonging to the data source from the vector store upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the underlying data. This flag is ignored if an Amazon Web Services account is deleted. RETAIN: Retains all underlying data in your vector store upon deletion of a knowledge base or data source resource.
|
997
1257
|
*/
|
998
1258
|
dataDeletionPolicy?: DataDeletionPolicy;
|
999
1259
|
/**
|
1000
|
-
*
|
1260
|
+
* The connection configuration for the data source.
|
1001
1261
|
*/
|
1002
1262
|
dataSourceConfiguration: DataSourceConfiguration;
|
1003
1263
|
/**
|
@@ -1027,208 +1287,558 @@ declare namespace BedrockAgent {
|
|
1027
1287
|
*/
|
1028
1288
|
dataSource: DataSource;
|
1029
1289
|
}
|
1030
|
-
export interface
|
1290
|
+
export interface CreateFlowAliasRequest {
|
1031
1291
|
/**
|
1032
1292
|
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1033
1293
|
*/
|
1034
1294
|
clientToken?: ClientToken;
|
1035
1295
|
/**
|
1036
|
-
* A description
|
1296
|
+
* A description for the alias.
|
1037
1297
|
*/
|
1038
1298
|
description?: Description;
|
1039
1299
|
/**
|
1040
|
-
*
|
1300
|
+
* The unique identifier of the flow for which to create an alias.
|
1041
1301
|
*/
|
1042
|
-
|
1302
|
+
flowIdentifier: FlowIdentifier;
|
1043
1303
|
/**
|
1044
|
-
* A name for the
|
1304
|
+
* A name for the alias.
|
1045
1305
|
*/
|
1046
1306
|
name: Name;
|
1047
1307
|
/**
|
1048
|
-
*
|
1049
|
-
*/
|
1050
|
-
roleArn: KnowledgeBaseRoleArn;
|
1051
|
-
/**
|
1052
|
-
* Contains details about the configuration of the vector database used for the knowledge base.
|
1308
|
+
* Contains information about the version to which to map the alias.
|
1053
1309
|
*/
|
1054
|
-
|
1310
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
1055
1311
|
/**
|
1056
|
-
*
|
1312
|
+
* Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.
|
1057
1313
|
*/
|
1058
1314
|
tags?: TagsMap;
|
1059
1315
|
}
|
1060
|
-
export interface
|
1316
|
+
export interface CreateFlowAliasResponse {
|
1061
1317
|
/**
|
1062
|
-
*
|
1318
|
+
* The Amazon Resource Name (ARN) of the alias.
|
1063
1319
|
*/
|
1064
|
-
|
1065
|
-
}
|
1066
|
-
export type CreationMode = "DEFAULT"|"OVERRIDDEN"|string;
|
1067
|
-
export type CustomControlMethod = "RETURN_CONTROL"|string;
|
1068
|
-
export type DataDeletionPolicy = "RETAIN"|"DELETE"|string;
|
1069
|
-
export interface DataSource {
|
1320
|
+
arn: FlowAliasArn;
|
1070
1321
|
/**
|
1071
|
-
* The time at which the
|
1322
|
+
* The time at which the alias was created.
|
1072
1323
|
*/
|
1073
1324
|
createdAt: DateTimestamp;
|
1074
1325
|
/**
|
1075
|
-
* The
|
1326
|
+
* The description of the alias.
|
1076
1327
|
*/
|
1077
|
-
|
1328
|
+
description?: Description;
|
1078
1329
|
/**
|
1079
|
-
*
|
1330
|
+
* The unique identifier of the flow that the alias belongs to.
|
1080
1331
|
*/
|
1081
|
-
|
1332
|
+
flowId: FlowId;
|
1082
1333
|
/**
|
1083
|
-
* The unique identifier of the
|
1334
|
+
* The unique identifier of the alias.
|
1084
1335
|
*/
|
1085
|
-
|
1336
|
+
id: FlowAliasId;
|
1086
1337
|
/**
|
1087
|
-
* The
|
1338
|
+
* The name of the alias.
|
1088
1339
|
*/
|
1089
|
-
|
1340
|
+
name: Name;
|
1090
1341
|
/**
|
1091
|
-
*
|
1342
|
+
* Contains information about the version that the alias is mapped to.
|
1092
1343
|
*/
|
1093
|
-
|
1344
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
1094
1345
|
/**
|
1095
|
-
* The
|
1346
|
+
* The time at which the alias of the flow was last updated.
|
1096
1347
|
*/
|
1097
|
-
|
1348
|
+
updatedAt: DateTimestamp;
|
1349
|
+
}
|
1350
|
+
export interface CreateFlowRequest {
|
1098
1351
|
/**
|
1099
|
-
*
|
1352
|
+
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1100
1353
|
*/
|
1101
|
-
|
1354
|
+
clientToken?: ClientToken;
|
1102
1355
|
/**
|
1103
|
-
*
|
1356
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
|
1104
1357
|
*/
|
1105
|
-
|
1358
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1106
1359
|
/**
|
1107
|
-
*
|
1360
|
+
* A definition of the nodes and connections between nodes in the flow.
|
1108
1361
|
*/
|
1109
|
-
|
1362
|
+
definition?: FlowDefinition;
|
1110
1363
|
/**
|
1111
|
-
*
|
1364
|
+
* A description for the flow.
|
1112
1365
|
*/
|
1113
|
-
|
1366
|
+
description?: FlowDescription;
|
1114
1367
|
/**
|
1115
|
-
*
|
1368
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
1116
1369
|
*/
|
1117
|
-
|
1118
|
-
}
|
1119
|
-
export interface DataSourceConfiguration {
|
1370
|
+
executionRoleArn: FlowExecutionRoleArn;
|
1120
1371
|
/**
|
1121
|
-
*
|
1372
|
+
* A name for the flow.
|
1122
1373
|
*/
|
1123
|
-
|
1374
|
+
name: FlowName;
|
1124
1375
|
/**
|
1125
|
-
*
|
1376
|
+
* Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.
|
1126
1377
|
*/
|
1127
|
-
|
1378
|
+
tags?: TagsMap;
|
1128
1379
|
}
|
1129
|
-
export
|
1130
|
-
export type DataSourceSummaries = DataSourceSummary[];
|
1131
|
-
export interface DataSourceSummary {
|
1380
|
+
export interface CreateFlowResponse {
|
1132
1381
|
/**
|
1133
|
-
* The
|
1382
|
+
* The Amazon Resource Name (ARN) of the flow.
|
1134
1383
|
*/
|
1135
|
-
|
1384
|
+
arn: FlowArn;
|
1136
1385
|
/**
|
1137
|
-
* The
|
1386
|
+
* The time at which the flow was created.
|
1138
1387
|
*/
|
1139
|
-
|
1388
|
+
createdAt: DateTimestamp;
|
1140
1389
|
/**
|
1141
|
-
* The
|
1390
|
+
* The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
|
1142
1391
|
*/
|
1143
|
-
|
1392
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1144
1393
|
/**
|
1145
|
-
*
|
1394
|
+
* A definition of the nodes and connections between nodes in the flow.
|
1146
1395
|
*/
|
1147
|
-
|
1396
|
+
definition?: FlowDefinition;
|
1148
1397
|
/**
|
1149
|
-
* The
|
1398
|
+
* The description of the flow.
|
1150
1399
|
*/
|
1151
|
-
|
1400
|
+
description?: FlowDescription;
|
1152
1401
|
/**
|
1153
|
-
* The
|
1402
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
1154
1403
|
*/
|
1155
|
-
|
1156
|
-
}
|
1157
|
-
export type DataSourceType = "S3"|string;
|
1158
|
-
export type DateTimestamp = Date;
|
1159
|
-
export interface DeleteAgentActionGroupRequest {
|
1404
|
+
executionRoleArn: FlowExecutionRoleArn;
|
1160
1405
|
/**
|
1161
|
-
* The unique identifier of the
|
1406
|
+
* The unique identifier of the flow.
|
1162
1407
|
*/
|
1163
|
-
|
1408
|
+
id: FlowId;
|
1164
1409
|
/**
|
1165
|
-
* The
|
1410
|
+
* The name of the flow.
|
1166
1411
|
*/
|
1167
|
-
|
1412
|
+
name: FlowName;
|
1168
1413
|
/**
|
1169
|
-
* The
|
1414
|
+
* The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.
|
1170
1415
|
*/
|
1171
|
-
|
1416
|
+
status: FlowStatus;
|
1172
1417
|
/**
|
1173
|
-
*
|
1418
|
+
* The time at which the flow was last updated.
|
1174
1419
|
*/
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1420
|
+
updatedAt: DateTimestamp;
|
1421
|
+
/**
|
1422
|
+
* The version of the flow. When you create a flow, the version created is the DRAFT version.
|
1423
|
+
*/
|
1424
|
+
version: DraftVersion;
|
1178
1425
|
}
|
1179
|
-
export interface
|
1426
|
+
export interface CreateFlowVersionRequest {
|
1180
1427
|
/**
|
1181
|
-
*
|
1428
|
+
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1182
1429
|
*/
|
1183
|
-
|
1430
|
+
clientToken?: ClientToken;
|
1184
1431
|
/**
|
1185
|
-
*
|
1432
|
+
* A description of the version of the flow.
|
1186
1433
|
*/
|
1187
|
-
|
1434
|
+
description?: FlowDescription;
|
1435
|
+
/**
|
1436
|
+
* The unique identifier of the flow that you want to create a version of.
|
1437
|
+
*/
|
1438
|
+
flowIdentifier: FlowIdentifier;
|
1188
1439
|
}
|
1189
|
-
export interface
|
1440
|
+
export interface CreateFlowVersionResponse {
|
1190
1441
|
/**
|
1191
|
-
* The
|
1442
|
+
* The Amazon Resource Name (ARN) of the flow.
|
1192
1443
|
*/
|
1193
|
-
|
1444
|
+
arn: FlowArn;
|
1194
1445
|
/**
|
1195
|
-
* The
|
1446
|
+
* The time at which the flow was created.
|
1196
1447
|
*/
|
1197
|
-
|
1448
|
+
createdAt: DateTimestamp;
|
1198
1449
|
/**
|
1199
|
-
* The
|
1450
|
+
* The KMS key that the flow is encrypted with.
|
1200
1451
|
*/
|
1201
|
-
|
1202
|
-
}
|
1203
|
-
export interface DeleteAgentRequest {
|
1452
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1204
1453
|
/**
|
1205
|
-
*
|
1454
|
+
* A definition of the nodes and connections in the flow.
|
1206
1455
|
*/
|
1207
|
-
|
1456
|
+
definition?: FlowDefinition;
|
1208
1457
|
/**
|
1209
|
-
*
|
1458
|
+
* The description of the flow version.
|
1210
1459
|
*/
|
1211
|
-
|
1212
|
-
}
|
1213
|
-
export interface DeleteAgentResponse {
|
1460
|
+
description?: FlowDescription;
|
1214
1461
|
/**
|
1215
|
-
* The
|
1462
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
1216
1463
|
*/
|
1217
|
-
|
1464
|
+
executionRoleArn: FlowExecutionRoleArn;
|
1218
1465
|
/**
|
1219
|
-
* The
|
1466
|
+
* The unique identifier of the flow.
|
1220
1467
|
*/
|
1221
|
-
|
1222
|
-
}
|
1223
|
-
export interface DeleteAgentVersionRequest {
|
1468
|
+
id: FlowId;
|
1224
1469
|
/**
|
1225
|
-
* The
|
1470
|
+
* The name of the flow version.
|
1226
1471
|
*/
|
1227
|
-
|
1472
|
+
name: FlowName;
|
1228
1473
|
/**
|
1229
|
-
* The
|
1474
|
+
* The status of the flow.
|
1230
1475
|
*/
|
1231
|
-
|
1476
|
+
status: FlowStatus;
|
1477
|
+
/**
|
1478
|
+
* The version of the flow that was created. Versions are numbered incrementally, starting from 1.
|
1479
|
+
*/
|
1480
|
+
version: NumericalVersion;
|
1481
|
+
}
|
1482
|
+
export interface CreateKnowledgeBaseRequest {
|
1483
|
+
/**
|
1484
|
+
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1485
|
+
*/
|
1486
|
+
clientToken?: ClientToken;
|
1487
|
+
/**
|
1488
|
+
* A description of the knowledge base.
|
1489
|
+
*/
|
1490
|
+
description?: Description;
|
1491
|
+
/**
|
1492
|
+
* Contains details about the embeddings model used for the knowledge base.
|
1493
|
+
*/
|
1494
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
|
1495
|
+
/**
|
1496
|
+
* A name for the knowledge base.
|
1497
|
+
*/
|
1498
|
+
name: Name;
|
1499
|
+
/**
|
1500
|
+
* The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
|
1501
|
+
*/
|
1502
|
+
roleArn: KnowledgeBaseRoleArn;
|
1503
|
+
/**
|
1504
|
+
* Contains details about the configuration of the vector database used for the knowledge base.
|
1505
|
+
*/
|
1506
|
+
storageConfiguration: StorageConfiguration;
|
1507
|
+
/**
|
1508
|
+
* Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
|
1509
|
+
*/
|
1510
|
+
tags?: TagsMap;
|
1511
|
+
}
|
1512
|
+
export interface CreateKnowledgeBaseResponse {
|
1513
|
+
/**
|
1514
|
+
* Contains details about the knowledge base.
|
1515
|
+
*/
|
1516
|
+
knowledgeBase: KnowledgeBase;
|
1517
|
+
}
|
1518
|
+
export interface CreatePromptRequest {
|
1519
|
+
/**
|
1520
|
+
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1521
|
+
*/
|
1522
|
+
clientToken?: ClientToken;
|
1523
|
+
/**
|
1524
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
|
1525
|
+
*/
|
1526
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1527
|
+
/**
|
1528
|
+
* The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
|
1529
|
+
*/
|
1530
|
+
defaultVariant?: PromptVariantName;
|
1531
|
+
/**
|
1532
|
+
* A description for the prompt.
|
1533
|
+
*/
|
1534
|
+
description?: PromptDescription;
|
1535
|
+
/**
|
1536
|
+
* A name for the prompt.
|
1537
|
+
*/
|
1538
|
+
name: PromptName;
|
1539
|
+
/**
|
1540
|
+
* Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.
|
1541
|
+
*/
|
1542
|
+
tags?: TagsMap;
|
1543
|
+
/**
|
1544
|
+
* A list of objects, each containing details about a variant of the prompt.
|
1545
|
+
*/
|
1546
|
+
variants?: PromptVariantList;
|
1547
|
+
}
|
1548
|
+
export interface CreatePromptResponse {
|
1549
|
+
/**
|
1550
|
+
* The Amazon Resource Name (ARN) of the prompt.
|
1551
|
+
*/
|
1552
|
+
arn: PromptArn;
|
1553
|
+
/**
|
1554
|
+
* The time at which the prompt was created.
|
1555
|
+
*/
|
1556
|
+
createdAt: DateTimestamp;
|
1557
|
+
/**
|
1558
|
+
* The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
|
1559
|
+
*/
|
1560
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1561
|
+
/**
|
1562
|
+
* The name of the default variant for your prompt.
|
1563
|
+
*/
|
1564
|
+
defaultVariant?: PromptVariantName;
|
1565
|
+
/**
|
1566
|
+
* The description of the prompt.
|
1567
|
+
*/
|
1568
|
+
description?: PromptDescription;
|
1569
|
+
/**
|
1570
|
+
* The unique identifier of the prompt.
|
1571
|
+
*/
|
1572
|
+
id: PromptId;
|
1573
|
+
/**
|
1574
|
+
* The name of the prompt.
|
1575
|
+
*/
|
1576
|
+
name: PromptName;
|
1577
|
+
/**
|
1578
|
+
* The time at which the prompt was last updated.
|
1579
|
+
*/
|
1580
|
+
updatedAt: DateTimestamp;
|
1581
|
+
/**
|
1582
|
+
* A list of objects, each containing details about a variant of the prompt.
|
1583
|
+
*/
|
1584
|
+
variants?: PromptVariantList;
|
1585
|
+
/**
|
1586
|
+
* The version of the prompt. When you create a prompt, the version created is the DRAFT version.
|
1587
|
+
*/
|
1588
|
+
version: Version;
|
1589
|
+
}
|
1590
|
+
export interface CreatePromptVersionRequest {
|
1591
|
+
/**
|
1592
|
+
* A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
|
1593
|
+
*/
|
1594
|
+
clientToken?: ClientToken;
|
1595
|
+
/**
|
1596
|
+
* A description for the version of the prompt.
|
1597
|
+
*/
|
1598
|
+
description?: PromptDescription;
|
1599
|
+
/**
|
1600
|
+
* The unique identifier of the prompt that you want to create a version of.
|
1601
|
+
*/
|
1602
|
+
promptIdentifier: PromptIdentifier;
|
1603
|
+
/**
|
1604
|
+
* Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
|
1605
|
+
*/
|
1606
|
+
tags?: TagsMap;
|
1607
|
+
}
|
1608
|
+
export interface CreatePromptVersionResponse {
|
1609
|
+
/**
|
1610
|
+
* The Amazon Resource Name (ARN) of the version of the prompt.
|
1611
|
+
*/
|
1612
|
+
arn: PromptArn;
|
1613
|
+
/**
|
1614
|
+
* The time at which the prompt was created.
|
1615
|
+
*/
|
1616
|
+
createdAt: DateTimestamp;
|
1617
|
+
/**
|
1618
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
|
1619
|
+
*/
|
1620
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
1621
|
+
/**
|
1622
|
+
* The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
|
1623
|
+
*/
|
1624
|
+
defaultVariant?: PromptVariantName;
|
1625
|
+
/**
|
1626
|
+
* A description for the prompt version.
|
1627
|
+
*/
|
1628
|
+
description?: PromptDescription;
|
1629
|
+
/**
|
1630
|
+
* The unique identifier of the prompt.
|
1631
|
+
*/
|
1632
|
+
id: PromptId;
|
1633
|
+
/**
|
1634
|
+
* The name of the prompt version.
|
1635
|
+
*/
|
1636
|
+
name: PromptName;
|
1637
|
+
/**
|
1638
|
+
* The time at which the prompt was last updated.
|
1639
|
+
*/
|
1640
|
+
updatedAt: DateTimestamp;
|
1641
|
+
/**
|
1642
|
+
* A list of objects, each containing details about a variant of the prompt.
|
1643
|
+
*/
|
1644
|
+
variants?: PromptVariantList;
|
1645
|
+
/**
|
1646
|
+
* The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
|
1647
|
+
*/
|
1648
|
+
version: Version;
|
1649
|
+
}
|
1650
|
+
export type CreationMode = "DEFAULT"|"OVERRIDDEN"|string;
|
1651
|
+
export type CustomControlMethod = "RETURN_CONTROL"|string;
|
1652
|
+
export interface CustomTransformationConfiguration {
|
1653
|
+
/**
|
1654
|
+
* An S3 bucket path for input and output objects.
|
1655
|
+
*/
|
1656
|
+
intermediateStorage: IntermediateStorage;
|
1657
|
+
/**
|
1658
|
+
* A Lambda function that processes documents.
|
1659
|
+
*/
|
1660
|
+
transformations: Transformations;
|
1661
|
+
}
|
1662
|
+
export type DataDeletionPolicy = "RETAIN"|"DELETE"|string;
|
1663
|
+
export interface DataSource {
|
1664
|
+
/**
|
1665
|
+
* The time at which the data source was created.
|
1666
|
+
*/
|
1667
|
+
createdAt: DateTimestamp;
|
1668
|
+
/**
|
1669
|
+
* The data deletion policy for the data source.
|
1670
|
+
*/
|
1671
|
+
dataDeletionPolicy?: DataDeletionPolicy;
|
1672
|
+
/**
|
1673
|
+
* The connection configuration for the data source.
|
1674
|
+
*/
|
1675
|
+
dataSourceConfiguration: DataSourceConfiguration;
|
1676
|
+
/**
|
1677
|
+
* The unique identifier of the data source.
|
1678
|
+
*/
|
1679
|
+
dataSourceId: Id;
|
1680
|
+
/**
|
1681
|
+
* The description of the data source.
|
1682
|
+
*/
|
1683
|
+
description?: Description;
|
1684
|
+
/**
|
1685
|
+
* The detailed reasons on the failure to delete a data source.
|
1686
|
+
*/
|
1687
|
+
failureReasons?: FailureReasons;
|
1688
|
+
/**
|
1689
|
+
* The unique identifier of the knowledge base to which the data source belongs.
|
1690
|
+
*/
|
1691
|
+
knowledgeBaseId: Id;
|
1692
|
+
/**
|
1693
|
+
* The name of the data source.
|
1694
|
+
*/
|
1695
|
+
name: Name;
|
1696
|
+
/**
|
1697
|
+
* Contains details about the configuration of the server-side encryption.
|
1698
|
+
*/
|
1699
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
1700
|
+
/**
|
1701
|
+
* The status of the data source. The following statuses are possible: Available – The data source has been created and is ready for ingestion into the knowledge base. Deleting – The data source is being deleted.
|
1702
|
+
*/
|
1703
|
+
status: DataSourceStatus;
|
1704
|
+
/**
|
1705
|
+
* The time at which the data source was last updated.
|
1706
|
+
*/
|
1707
|
+
updatedAt: DateTimestamp;
|
1708
|
+
/**
|
1709
|
+
* Contains details about how to ingest the documents in the data source.
|
1710
|
+
*/
|
1711
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
1712
|
+
}
|
1713
|
+
export interface DataSourceConfiguration {
|
1714
|
+
/**
|
1715
|
+
* The configuration information to connect to Confluence as your data source. Confluence data source connector is in preview release and is subject to change.
|
1716
|
+
*/
|
1717
|
+
confluenceConfiguration?: ConfluenceDataSourceConfiguration;
|
1718
|
+
/**
|
1719
|
+
* The configuration information to connect to Amazon S3 as your data source.
|
1720
|
+
*/
|
1721
|
+
s3Configuration?: S3DataSourceConfiguration;
|
1722
|
+
/**
|
1723
|
+
* The configuration information to connect to Salesforce as your data source. Salesforce data source connector is in preview release and is subject to change.
|
1724
|
+
*/
|
1725
|
+
salesforceConfiguration?: SalesforceDataSourceConfiguration;
|
1726
|
+
/**
|
1727
|
+
* The configuration information to connect to SharePoint as your data source. SharePoint data source connector is in preview release and is subject to change.
|
1728
|
+
*/
|
1729
|
+
sharePointConfiguration?: SharePointDataSourceConfiguration;
|
1730
|
+
/**
|
1731
|
+
* The type of data source.
|
1732
|
+
*/
|
1733
|
+
type: DataSourceType;
|
1734
|
+
/**
|
1735
|
+
* The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs. Crawling web URLs as your data source is in preview release and is subject to change.
|
1736
|
+
*/
|
1737
|
+
webConfiguration?: WebDataSourceConfiguration;
|
1738
|
+
}
|
1739
|
+
export type DataSourceStatus = "AVAILABLE"|"DELETING"|"DELETE_UNSUCCESSFUL"|string;
|
1740
|
+
export type DataSourceSummaries = DataSourceSummary[];
|
1741
|
+
export interface DataSourceSummary {
|
1742
|
+
/**
|
1743
|
+
* The unique identifier of the data source.
|
1744
|
+
*/
|
1745
|
+
dataSourceId: Id;
|
1746
|
+
/**
|
1747
|
+
* The description of the data source.
|
1748
|
+
*/
|
1749
|
+
description?: Description;
|
1750
|
+
/**
|
1751
|
+
* The unique identifier of the knowledge base to which the data source belongs.
|
1752
|
+
*/
|
1753
|
+
knowledgeBaseId: Id;
|
1754
|
+
/**
|
1755
|
+
* The name of the data source.
|
1756
|
+
*/
|
1757
|
+
name: Name;
|
1758
|
+
/**
|
1759
|
+
* The status of the data source.
|
1760
|
+
*/
|
1761
|
+
status: DataSourceStatus;
|
1762
|
+
/**
|
1763
|
+
* The time at which the data source was last updated.
|
1764
|
+
*/
|
1765
|
+
updatedAt: DateTimestamp;
|
1766
|
+
}
|
1767
|
+
export type DataSourceType = "S3"|"WEB"|"CONFLUENCE"|"SALESFORCE"|"SHAREPOINT"|string;
|
1768
|
+
export type DateTimestamp = Date;
|
1769
|
+
export interface DeleteAgentActionGroupRequest {
|
1770
|
+
/**
|
1771
|
+
* The unique identifier of the action group to delete.
|
1772
|
+
*/
|
1773
|
+
actionGroupId: Id;
|
1774
|
+
/**
|
1775
|
+
* The unique identifier of the agent that the action group belongs to.
|
1776
|
+
*/
|
1777
|
+
agentId: Id;
|
1778
|
+
/**
|
1779
|
+
* The version of the agent that the action group belongs to.
|
1780
|
+
*/
|
1781
|
+
agentVersion: DraftVersion;
|
1782
|
+
/**
|
1783
|
+
* By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
|
1784
|
+
*/
|
1785
|
+
skipResourceInUseCheck?: Boolean;
|
1786
|
+
}
|
1787
|
+
export interface DeleteAgentActionGroupResponse {
|
1788
|
+
}
|
1789
|
+
export interface DeleteAgentAliasRequest {
|
1790
|
+
/**
|
1791
|
+
* The unique identifier of the alias to delete.
|
1792
|
+
*/
|
1793
|
+
agentAliasId: AgentAliasId;
|
1794
|
+
/**
|
1795
|
+
* The unique identifier of the agent that the alias belongs to.
|
1796
|
+
*/
|
1797
|
+
agentId: Id;
|
1798
|
+
}
|
1799
|
+
export interface DeleteAgentAliasResponse {
|
1800
|
+
/**
|
1801
|
+
* The unique identifier of the alias that was deleted.
|
1802
|
+
*/
|
1803
|
+
agentAliasId: AgentAliasId;
|
1804
|
+
/**
|
1805
|
+
* The status of the alias.
|
1806
|
+
*/
|
1807
|
+
agentAliasStatus: AgentAliasStatus;
|
1808
|
+
/**
|
1809
|
+
* The unique identifier of the agent that the alias belongs to.
|
1810
|
+
*/
|
1811
|
+
agentId: Id;
|
1812
|
+
}
|
1813
|
+
export interface DeleteAgentRequest {
|
1814
|
+
/**
|
1815
|
+
* The unique identifier of the agent to delete.
|
1816
|
+
*/
|
1817
|
+
agentId: Id;
|
1818
|
+
/**
|
1819
|
+
* By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
|
1820
|
+
*/
|
1821
|
+
skipResourceInUseCheck?: Boolean;
|
1822
|
+
}
|
1823
|
+
export interface DeleteAgentResponse {
|
1824
|
+
/**
|
1825
|
+
* The unique identifier of the agent that was deleted.
|
1826
|
+
*/
|
1827
|
+
agentId: Id;
|
1828
|
+
/**
|
1829
|
+
* The status of the agent.
|
1830
|
+
*/
|
1831
|
+
agentStatus: AgentStatus;
|
1832
|
+
}
|
1833
|
+
export interface DeleteAgentVersionRequest {
|
1834
|
+
/**
|
1835
|
+
* The unique identifier of the agent that the version belongs to.
|
1836
|
+
*/
|
1837
|
+
agentId: Id;
|
1838
|
+
/**
|
1839
|
+
* The version of the agent to delete.
|
1840
|
+
*/
|
1841
|
+
agentVersion: NumericalVersion;
|
1232
1842
|
/**
|
1233
1843
|
* By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
|
1234
1844
|
*/
|
@@ -1264,13 +1874,73 @@ declare namespace BedrockAgent {
|
|
1264
1874
|
*/
|
1265
1875
|
dataSourceId: Id;
|
1266
1876
|
/**
|
1267
|
-
* The unique identifier of the knowledge base to which the data source that was deleted belonged.
|
1877
|
+
* The unique identifier of the knowledge base to which the data source that was deleted belonged.
|
1878
|
+
*/
|
1879
|
+
knowledgeBaseId: Id;
|
1880
|
+
/**
|
1881
|
+
* The status of the data source.
|
1882
|
+
*/
|
1883
|
+
status: DataSourceStatus;
|
1884
|
+
}
|
1885
|
+
export interface DeleteFlowAliasRequest {
|
1886
|
+
/**
|
1887
|
+
* The unique identifier of the alias to be deleted.
|
1888
|
+
*/
|
1889
|
+
aliasIdentifier: FlowAliasIdentifier;
|
1890
|
+
/**
|
1891
|
+
* The unique identifier of the flow that the alias belongs to.
|
1892
|
+
*/
|
1893
|
+
flowIdentifier: FlowIdentifier;
|
1894
|
+
}
|
1895
|
+
export interface DeleteFlowAliasResponse {
|
1896
|
+
/**
|
1897
|
+
* The unique identifier of the flow that the alias belongs to.
|
1898
|
+
*/
|
1899
|
+
flowId: FlowId;
|
1900
|
+
/**
|
1901
|
+
* The unique identifier of the flow.
|
1902
|
+
*/
|
1903
|
+
id: FlowAliasId;
|
1904
|
+
}
|
1905
|
+
export interface DeleteFlowRequest {
|
1906
|
+
/**
|
1907
|
+
* The unique identifier of the flow.
|
1908
|
+
*/
|
1909
|
+
flowIdentifier: FlowIdentifier;
|
1910
|
+
/**
|
1911
|
+
* By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
|
1912
|
+
*/
|
1913
|
+
skipResourceInUseCheck?: Boolean;
|
1914
|
+
}
|
1915
|
+
export interface DeleteFlowResponse {
|
1916
|
+
/**
|
1917
|
+
* The unique identifier of the flow.
|
1918
|
+
*/
|
1919
|
+
id: FlowId;
|
1920
|
+
}
|
1921
|
+
export interface DeleteFlowVersionRequest {
|
1922
|
+
/**
|
1923
|
+
* The unique identifier of the flow whose version that you want to delete
|
1924
|
+
*/
|
1925
|
+
flowIdentifier: FlowIdentifier;
|
1926
|
+
/**
|
1927
|
+
* The version of the flow that you want to delete.
|
1928
|
+
*/
|
1929
|
+
flowVersion: NumericalVersion;
|
1930
|
+
/**
|
1931
|
+
* By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
|
1932
|
+
*/
|
1933
|
+
skipResourceInUseCheck?: Boolean;
|
1934
|
+
}
|
1935
|
+
export interface DeleteFlowVersionResponse {
|
1936
|
+
/**
|
1937
|
+
* The unique identifier of the flow.
|
1268
1938
|
*/
|
1269
|
-
|
1939
|
+
id: Id;
|
1270
1940
|
/**
|
1271
|
-
* The
|
1941
|
+
* The version of the flow being deleted.
|
1272
1942
|
*/
|
1273
|
-
|
1943
|
+
version: NumericalVersion;
|
1274
1944
|
}
|
1275
1945
|
export interface DeleteKnowledgeBaseRequest {
|
1276
1946
|
/**
|
@@ -1288,6 +1958,26 @@ declare namespace BedrockAgent {
|
|
1288
1958
|
*/
|
1289
1959
|
status: KnowledgeBaseStatus;
|
1290
1960
|
}
|
1961
|
+
export interface DeletePromptRequest {
|
1962
|
+
/**
|
1963
|
+
* The unique identifier of the prompt.
|
1964
|
+
*/
|
1965
|
+
promptIdentifier: PromptIdentifier;
|
1966
|
+
/**
|
1967
|
+
* The version of the prompt to delete.
|
1968
|
+
*/
|
1969
|
+
promptVersion?: NumericalVersion;
|
1970
|
+
}
|
1971
|
+
export interface DeletePromptResponse {
|
1972
|
+
/**
|
1973
|
+
* The unique identifier of the prompt that was deleted.
|
1974
|
+
*/
|
1975
|
+
id: PromptId;
|
1976
|
+
/**
|
1977
|
+
* The version of the prompt that was deleted.
|
1978
|
+
*/
|
1979
|
+
version?: NumericalVersion;
|
1980
|
+
}
|
1291
1981
|
export type Description = string;
|
1292
1982
|
export type Dimensions = number;
|
1293
1983
|
export interface DisassociateAgentKnowledgeBaseRequest {
|
@@ -1313,9 +2003,13 @@ declare namespace BedrockAgent {
|
|
1313
2003
|
*/
|
1314
2004
|
bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration;
|
1315
2005
|
}
|
2006
|
+
export type EnabledMemoryTypes = MemoryType[];
|
1316
2007
|
export type FailureReason = string;
|
1317
2008
|
export type FailureReasons = FailureReason[];
|
1318
2009
|
export type FieldName = string;
|
2010
|
+
export type FilterList = FilterPattern[];
|
2011
|
+
export type FilterPattern = string;
|
2012
|
+
export type FilteredObjectType = string;
|
1319
2013
|
export interface FixedSizeChunkingConfiguration {
|
1320
2014
|
/**
|
1321
2015
|
* The maximum number of tokens to include in a chunk.
|
@@ -1328,6 +2022,307 @@ declare namespace BedrockAgent {
|
|
1328
2022
|
}
|
1329
2023
|
export type FixedSizeChunkingConfigurationMaxTokensInteger = number;
|
1330
2024
|
export type FixedSizeChunkingConfigurationOverlapPercentageInteger = number;
|
2025
|
+
export type FlowAliasArn = string;
|
2026
|
+
export type FlowAliasId = string;
|
2027
|
+
export type FlowAliasIdentifier = string;
|
2028
|
+
export type FlowAliasRoutingConfiguration = FlowAliasRoutingConfigurationListItem[];
|
2029
|
+
export interface FlowAliasRoutingConfigurationListItem {
|
2030
|
+
/**
|
2031
|
+
* The version that the alias maps to.
|
2032
|
+
*/
|
2033
|
+
flowVersion?: Version;
|
2034
|
+
}
|
2035
|
+
export type FlowAliasSummaries = FlowAliasSummary[];
|
2036
|
+
export interface FlowAliasSummary {
|
2037
|
+
/**
|
2038
|
+
* The Amazon Resource Name (ARN) of the flow alias.
|
2039
|
+
*/
|
2040
|
+
arn: FlowAliasArn;
|
2041
|
+
/**
|
2042
|
+
* The time at which the alias was created.
|
2043
|
+
*/
|
2044
|
+
createdAt: DateTimestamp;
|
2045
|
+
/**
|
2046
|
+
* A description of the alias.
|
2047
|
+
*/
|
2048
|
+
description?: Description;
|
2049
|
+
/**
|
2050
|
+
* The unique identifier of the flow.
|
2051
|
+
*/
|
2052
|
+
flowId: FlowId;
|
2053
|
+
/**
|
2054
|
+
* The unique identifier of the alias of the flow.
|
2055
|
+
*/
|
2056
|
+
id: FlowAliasId;
|
2057
|
+
/**
|
2058
|
+
* The name of the alias.
|
2059
|
+
*/
|
2060
|
+
name: Name;
|
2061
|
+
/**
|
2062
|
+
* A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
|
2063
|
+
*/
|
2064
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
2065
|
+
/**
|
2066
|
+
* The time at which the alias was last updated.
|
2067
|
+
*/
|
2068
|
+
updatedAt: DateTimestamp;
|
2069
|
+
}
|
2070
|
+
export type FlowArn = string;
|
2071
|
+
export interface FlowCondition {
|
2072
|
+
/**
|
2073
|
+
* 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 Node types in prompt flows.
|
2074
|
+
*/
|
2075
|
+
expression?: FlowConditionExpression;
|
2076
|
+
/**
|
2077
|
+
* A name for the condition that you can reference.
|
2078
|
+
*/
|
2079
|
+
name: FlowConditionName;
|
2080
|
+
}
|
2081
|
+
export type FlowConditionExpression = string;
|
2082
|
+
export type FlowConditionName = string;
|
2083
|
+
export interface FlowConditionalConnectionConfiguration {
|
2084
|
+
/**
|
2085
|
+
* The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the Node types topic in the Amazon Bedrock User Guide.
|
2086
|
+
*/
|
2087
|
+
condition: FlowConditionName;
|
2088
|
+
}
|
2089
|
+
export type FlowConditions = FlowCondition[];
|
2090
|
+
export interface FlowConnection {
|
2091
|
+
/**
|
2092
|
+
* The configuration of the connection.
|
2093
|
+
*/
|
2094
|
+
configuration?: FlowConnectionConfiguration;
|
2095
|
+
/**
|
2096
|
+
* A name for the connection that you can reference.
|
2097
|
+
*/
|
2098
|
+
name: FlowConnectionName;
|
2099
|
+
/**
|
2100
|
+
* The node that the connection starts at.
|
2101
|
+
*/
|
2102
|
+
source: FlowNodeName;
|
2103
|
+
/**
|
2104
|
+
* The node that the connection ends at.
|
2105
|
+
*/
|
2106
|
+
target: FlowNodeName;
|
2107
|
+
/**
|
2108
|
+
* Whether the source node that the connection begins from is a condition node (Conditional) or not (Data).
|
2109
|
+
*/
|
2110
|
+
type: FlowConnectionType;
|
2111
|
+
}
|
2112
|
+
export interface FlowConnectionConfiguration {
|
2113
|
+
/**
|
2114
|
+
* The configuration of a connection originating from a Condition node.
|
2115
|
+
*/
|
2116
|
+
conditional?: FlowConditionalConnectionConfiguration;
|
2117
|
+
/**
|
2118
|
+
* The configuration of a connection originating from a node that isn't a Condition node.
|
2119
|
+
*/
|
2120
|
+
data?: FlowDataConnectionConfiguration;
|
2121
|
+
}
|
2122
|
+
export type FlowConnectionName = string;
|
2123
|
+
export type FlowConnectionType = "Data"|"Conditional"|string;
|
2124
|
+
export type FlowConnections = FlowConnection[];
|
2125
|
+
export interface FlowDataConnectionConfiguration {
|
2126
|
+
/**
|
2127
|
+
* The name of the output in the source node that the connection begins from.
|
2128
|
+
*/
|
2129
|
+
sourceOutput: FlowNodeOutputName;
|
2130
|
+
/**
|
2131
|
+
* The name of the input in the target node that the connection ends at.
|
2132
|
+
*/
|
2133
|
+
targetInput: FlowNodeInputName;
|
2134
|
+
}
|
2135
|
+
export interface FlowDefinition {
|
2136
|
+
/**
|
2137
|
+
* An array of connection definitions in the flow.
|
2138
|
+
*/
|
2139
|
+
connections?: FlowConnections;
|
2140
|
+
/**
|
2141
|
+
* An array of node definitions in the flow.
|
2142
|
+
*/
|
2143
|
+
nodes?: FlowNodes;
|
2144
|
+
}
|
2145
|
+
export type FlowDescription = string;
|
2146
|
+
export type FlowExecutionRoleArn = string;
|
2147
|
+
export type FlowId = string;
|
2148
|
+
export type FlowIdentifier = string;
|
2149
|
+
export type FlowName = string;
|
2150
|
+
export interface FlowNode {
|
2151
|
+
/**
|
2152
|
+
* Contains configurations for the node.
|
2153
|
+
*/
|
2154
|
+
configuration?: FlowNodeConfiguration;
|
2155
|
+
/**
|
2156
|
+
* An array of objects, each of which contains information about an input into the node.
|
2157
|
+
*/
|
2158
|
+
inputs?: FlowNodeInputs;
|
2159
|
+
/**
|
2160
|
+
* A name for the node.
|
2161
|
+
*/
|
2162
|
+
name: FlowNodeName;
|
2163
|
+
/**
|
2164
|
+
* A list of objects, each of which contains information about an output from the node.
|
2165
|
+
*/
|
2166
|
+
outputs?: FlowNodeOutputs;
|
2167
|
+
/**
|
2168
|
+
* The type of node. This value must match the name of the key that you provide in the configuration you provide in the FlowNodeConfiguration field.
|
2169
|
+
*/
|
2170
|
+
type: FlowNodeType;
|
2171
|
+
}
|
2172
|
+
export interface FlowNodeConfiguration {
|
2173
|
+
/**
|
2174
|
+
* Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
|
2175
|
+
*/
|
2176
|
+
agent?: AgentFlowNodeConfiguration;
|
2177
|
+
/**
|
2178
|
+
* Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
|
2179
|
+
*/
|
2180
|
+
collector?: CollectorFlowNodeConfiguration;
|
2181
|
+
/**
|
2182
|
+
* Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
|
2183
|
+
*/
|
2184
|
+
condition?: ConditionFlowNodeConfiguration;
|
2185
|
+
/**
|
2186
|
+
* Contains configurations for an input flow node in your flow. The first node in the flow. inputs can't be specified for this node.
|
2187
|
+
*/
|
2188
|
+
input?: InputFlowNodeConfiguration;
|
2189
|
+
/**
|
2190
|
+
* Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
|
2191
|
+
*/
|
2192
|
+
iterator?: IteratorFlowNodeConfiguration;
|
2193
|
+
/**
|
2194
|
+
* Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
|
2195
|
+
*/
|
2196
|
+
knowledgeBase?: KnowledgeBaseFlowNodeConfiguration;
|
2197
|
+
/**
|
2198
|
+
* Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
|
2199
|
+
*/
|
2200
|
+
lambdaFunction?: LambdaFunctionFlowNodeConfiguration;
|
2201
|
+
/**
|
2202
|
+
* Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
|
2203
|
+
*/
|
2204
|
+
lex?: LexFlowNodeConfiguration;
|
2205
|
+
/**
|
2206
|
+
* Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
|
2207
|
+
*/
|
2208
|
+
output?: OutputFlowNodeConfiguration;
|
2209
|
+
/**
|
2210
|
+
* Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
|
2211
|
+
*/
|
2212
|
+
prompt?: PromptFlowNodeConfiguration;
|
2213
|
+
/**
|
2214
|
+
* Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
|
2215
|
+
*/
|
2216
|
+
retrieval?: RetrievalFlowNodeConfiguration;
|
2217
|
+
/**
|
2218
|
+
* Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
|
2219
|
+
*/
|
2220
|
+
storage?: StorageFlowNodeConfiguration;
|
2221
|
+
}
|
2222
|
+
export type FlowNodeIODataType = "String"|"Number"|"Boolean"|"Object"|"Array"|string;
|
2223
|
+
export interface FlowNodeInput {
|
2224
|
+
/**
|
2225
|
+
* An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
|
2226
|
+
*/
|
2227
|
+
expression: FlowNodeInputExpression;
|
2228
|
+
/**
|
2229
|
+
* A name for the input that you can reference.
|
2230
|
+
*/
|
2231
|
+
name: FlowNodeInputName;
|
2232
|
+
/**
|
2233
|
+
* The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
|
2234
|
+
*/
|
2235
|
+
type: FlowNodeIODataType;
|
2236
|
+
}
|
2237
|
+
export type FlowNodeInputExpression = string;
|
2238
|
+
export type FlowNodeInputName = string;
|
2239
|
+
export type FlowNodeInputs = FlowNodeInput[];
|
2240
|
+
export type FlowNodeName = string;
|
2241
|
+
export interface FlowNodeOutput {
|
2242
|
+
/**
|
2243
|
+
* A name for the output that you can reference.
|
2244
|
+
*/
|
2245
|
+
name: FlowNodeOutputName;
|
2246
|
+
/**
|
2247
|
+
* The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
|
2248
|
+
*/
|
2249
|
+
type: FlowNodeIODataType;
|
2250
|
+
}
|
2251
|
+
export type FlowNodeOutputName = string;
|
2252
|
+
export type FlowNodeOutputs = FlowNodeOutput[];
|
2253
|
+
export type FlowNodeType = "Input"|"Output"|"KnowledgeBase"|"Condition"|"Lex"|"Prompt"|"LambdaFunction"|"Storage"|"Agent"|"Retrieval"|"Iterator"|"Collector"|string;
|
2254
|
+
export type FlowNodes = FlowNode[];
|
2255
|
+
export type FlowStatus = "Failed"|"Prepared"|"Preparing"|"NotPrepared"|string;
|
2256
|
+
export type FlowSummaries = FlowSummary[];
|
2257
|
+
export interface FlowSummary {
|
2258
|
+
/**
|
2259
|
+
* The Amazon Resource Name (ARN) of the flow.
|
2260
|
+
*/
|
2261
|
+
arn: FlowArn;
|
2262
|
+
/**
|
2263
|
+
* The time at which the flow was created.
|
2264
|
+
*/
|
2265
|
+
createdAt: DateTimestamp;
|
2266
|
+
/**
|
2267
|
+
* A description of the flow.
|
2268
|
+
*/
|
2269
|
+
description?: FlowDescription;
|
2270
|
+
/**
|
2271
|
+
* The unique identifier of the flow.
|
2272
|
+
*/
|
2273
|
+
id: FlowId;
|
2274
|
+
/**
|
2275
|
+
* The name of the flow.
|
2276
|
+
*/
|
2277
|
+
name: FlowName;
|
2278
|
+
/**
|
2279
|
+
* The status of the flow. The following statuses are possible: NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version. Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing. Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing. Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
|
2280
|
+
*/
|
2281
|
+
status: FlowStatus;
|
2282
|
+
/**
|
2283
|
+
* The time at which the flow was last updated.
|
2284
|
+
*/
|
2285
|
+
updatedAt: DateTimestamp;
|
2286
|
+
/**
|
2287
|
+
* The latest version of the flow.
|
2288
|
+
*/
|
2289
|
+
version: DraftVersion;
|
2290
|
+
}
|
2291
|
+
export interface FlowValidation {
|
2292
|
+
/**
|
2293
|
+
* A message describing the validation error.
|
2294
|
+
*/
|
2295
|
+
message: NonBlankString;
|
2296
|
+
/**
|
2297
|
+
* The severity of the issue described in the message.
|
2298
|
+
*/
|
2299
|
+
severity: FlowValidationSeverity;
|
2300
|
+
}
|
2301
|
+
export type FlowValidationSeverity = "Warning"|"Error"|string;
|
2302
|
+
export type FlowValidations = FlowValidation[];
|
2303
|
+
export type FlowVersionSummaries = FlowVersionSummary[];
|
2304
|
+
export interface FlowVersionSummary {
|
2305
|
+
/**
|
2306
|
+
* The Amazon Resource Name (ARN) of the flow that the version belongs to.
|
2307
|
+
*/
|
2308
|
+
arn: FlowArn;
|
2309
|
+
/**
|
2310
|
+
* The time at the flow version was created.
|
2311
|
+
*/
|
2312
|
+
createdAt: DateTimestamp;
|
2313
|
+
/**
|
2314
|
+
* The unique identifier of the flow.
|
2315
|
+
*/
|
2316
|
+
id: FlowId;
|
2317
|
+
/**
|
2318
|
+
* The status of the flow.
|
2319
|
+
*/
|
2320
|
+
status: FlowStatus;
|
2321
|
+
/**
|
2322
|
+
* The version of the flow.
|
2323
|
+
*/
|
2324
|
+
version: NumericalVersion;
|
2325
|
+
}
|
1331
2326
|
export interface Function {
|
1332
2327
|
/**
|
1333
2328
|
* A description of the function and its purpose.
|
@@ -1432,23 +2427,175 @@ declare namespace BedrockAgent {
|
|
1432
2427
|
/**
|
1433
2428
|
* Contains details about the version of the agent.
|
1434
2429
|
*/
|
1435
|
-
agentVersion: AgentVersion;
|
1436
|
-
}
|
1437
|
-
export interface GetDataSourceRequest {
|
2430
|
+
agentVersion: AgentVersion;
|
2431
|
+
}
|
2432
|
+
export interface GetDataSourceRequest {
|
2433
|
+
/**
|
2434
|
+
* The unique identifier of the data source.
|
2435
|
+
*/
|
2436
|
+
dataSourceId: Id;
|
2437
|
+
/**
|
2438
|
+
* The unique identifier of the knowledge base that the data source was added to.
|
2439
|
+
*/
|
2440
|
+
knowledgeBaseId: Id;
|
2441
|
+
}
|
2442
|
+
export interface GetDataSourceResponse {
|
2443
|
+
/**
|
2444
|
+
* Contains details about the data source.
|
2445
|
+
*/
|
2446
|
+
dataSource: DataSource;
|
2447
|
+
}
|
2448
|
+
export interface GetFlowAliasRequest {
|
2449
|
+
/**
|
2450
|
+
* The unique identifier of the alias for which to retrieve information.
|
2451
|
+
*/
|
2452
|
+
aliasIdentifier: FlowAliasIdentifier;
|
2453
|
+
/**
|
2454
|
+
* The unique identifier of the flow that the alias belongs to.
|
2455
|
+
*/
|
2456
|
+
flowIdentifier: FlowIdentifier;
|
2457
|
+
}
|
2458
|
+
export interface GetFlowAliasResponse {
|
2459
|
+
/**
|
2460
|
+
* The Amazon Resource Name (ARN) of the flow.
|
2461
|
+
*/
|
2462
|
+
arn: FlowAliasArn;
|
2463
|
+
/**
|
2464
|
+
* The time at which the flow was created.
|
2465
|
+
*/
|
2466
|
+
createdAt: DateTimestamp;
|
2467
|
+
/**
|
2468
|
+
* The description of the flow.
|
2469
|
+
*/
|
2470
|
+
description?: Description;
|
2471
|
+
/**
|
2472
|
+
* The unique identifier of the flow that the alias belongs to.
|
2473
|
+
*/
|
2474
|
+
flowId: FlowId;
|
2475
|
+
/**
|
2476
|
+
* The unique identifier of the alias of the flow.
|
2477
|
+
*/
|
2478
|
+
id: FlowAliasId;
|
2479
|
+
/**
|
2480
|
+
* The name of the flow alias.
|
2481
|
+
*/
|
2482
|
+
name: Name;
|
2483
|
+
/**
|
2484
|
+
* Contains information about the version that the alias is mapped to.
|
2485
|
+
*/
|
2486
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
2487
|
+
/**
|
2488
|
+
* The time at which the flow alias was last updated.
|
2489
|
+
*/
|
2490
|
+
updatedAt: DateTimestamp;
|
2491
|
+
}
|
2492
|
+
export interface GetFlowRequest {
|
2493
|
+
/**
|
2494
|
+
* The unique identifier of the flow.
|
2495
|
+
*/
|
2496
|
+
flowIdentifier: FlowIdentifier;
|
2497
|
+
}
|
2498
|
+
export interface GetFlowResponse {
|
2499
|
+
/**
|
2500
|
+
* The Amazon Resource Name (ARN) of the flow.
|
2501
|
+
*/
|
2502
|
+
arn: FlowArn;
|
2503
|
+
/**
|
2504
|
+
* The time at which the flow was created.
|
2505
|
+
*/
|
2506
|
+
createdAt: DateTimestamp;
|
2507
|
+
/**
|
2508
|
+
* The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
|
2509
|
+
*/
|
2510
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
2511
|
+
/**
|
2512
|
+
* The definition of the nodes and connections between the nodes in the flow.
|
2513
|
+
*/
|
2514
|
+
definition?: FlowDefinition;
|
2515
|
+
/**
|
2516
|
+
* The description of the flow.
|
2517
|
+
*/
|
2518
|
+
description?: FlowDescription;
|
2519
|
+
/**
|
2520
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
|
2521
|
+
*/
|
2522
|
+
executionRoleArn: FlowExecutionRoleArn;
|
2523
|
+
/**
|
2524
|
+
* The unique identifier of the flow.
|
2525
|
+
*/
|
2526
|
+
id: FlowId;
|
2527
|
+
/**
|
2528
|
+
* The name of the flow.
|
2529
|
+
*/
|
2530
|
+
name: FlowName;
|
2531
|
+
/**
|
2532
|
+
* The status of the flow. The following statuses are possible: NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version. Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing. Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing. Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.
|
2533
|
+
*/
|
2534
|
+
status: FlowStatus;
|
2535
|
+
/**
|
2536
|
+
* The time at which the flow was last updated.
|
2537
|
+
*/
|
2538
|
+
updatedAt: DateTimestamp;
|
2539
|
+
/**
|
2540
|
+
* A list of validation error messages related to the last failed operation on the flow.
|
2541
|
+
*/
|
2542
|
+
validations?: FlowValidations;
|
2543
|
+
/**
|
2544
|
+
* The version of the flow for which information was retrieved.
|
2545
|
+
*/
|
2546
|
+
version: DraftVersion;
|
2547
|
+
}
|
2548
|
+
export interface GetFlowVersionRequest {
|
2549
|
+
/**
|
2550
|
+
* The unique identifier of the flow for which to get information.
|
2551
|
+
*/
|
2552
|
+
flowIdentifier: FlowIdentifier;
|
2553
|
+
/**
|
2554
|
+
* The version of the flow for which to get information.
|
2555
|
+
*/
|
2556
|
+
flowVersion: NumericalVersion;
|
2557
|
+
}
|
2558
|
+
export interface GetFlowVersionResponse {
|
2559
|
+
/**
|
2560
|
+
* The Amazon Resource Name (ARN) of the flow.
|
2561
|
+
*/
|
2562
|
+
arn: FlowArn;
|
2563
|
+
/**
|
2564
|
+
* The time at which the flow was created.
|
2565
|
+
*/
|
2566
|
+
createdAt: DateTimestamp;
|
2567
|
+
/**
|
2568
|
+
* The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
|
2569
|
+
*/
|
2570
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
2571
|
+
/**
|
2572
|
+
* The definition of the nodes and connections between nodes in the flow.
|
2573
|
+
*/
|
2574
|
+
definition?: FlowDefinition;
|
2575
|
+
/**
|
2576
|
+
* The description of the flow.
|
2577
|
+
*/
|
2578
|
+
description?: FlowDescription;
|
2579
|
+
/**
|
2580
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
2581
|
+
*/
|
2582
|
+
executionRoleArn: FlowExecutionRoleArn;
|
2583
|
+
/**
|
2584
|
+
* The unique identifier of the flow.
|
2585
|
+
*/
|
2586
|
+
id: FlowId;
|
1438
2587
|
/**
|
1439
|
-
* The
|
2588
|
+
* The name of the flow version.
|
1440
2589
|
*/
|
1441
|
-
|
2590
|
+
name: FlowName;
|
1442
2591
|
/**
|
1443
|
-
* The
|
2592
|
+
* The status of the flow.
|
1444
2593
|
*/
|
1445
|
-
|
1446
|
-
}
|
1447
|
-
export interface GetDataSourceResponse {
|
2594
|
+
status: FlowStatus;
|
1448
2595
|
/**
|
1449
|
-
*
|
2596
|
+
* The version of the flow for which information was retrieved.
|
1450
2597
|
*/
|
1451
|
-
|
2598
|
+
version: NumericalVersion;
|
1452
2599
|
}
|
1453
2600
|
export interface GetIngestionJobRequest {
|
1454
2601
|
/**
|
@@ -1482,18 +2629,90 @@ declare namespace BedrockAgent {
|
|
1482
2629
|
*/
|
1483
2630
|
knowledgeBase: KnowledgeBase;
|
1484
2631
|
}
|
2632
|
+
export interface GetPromptRequest {
|
2633
|
+
/**
|
2634
|
+
* The unique identifier of the prompt.
|
2635
|
+
*/
|
2636
|
+
promptIdentifier: PromptIdentifier;
|
2637
|
+
/**
|
2638
|
+
* The version of the prompt about which you want to retrieve information.
|
2639
|
+
*/
|
2640
|
+
promptVersion?: Version;
|
2641
|
+
}
|
2642
|
+
export interface GetPromptResponse {
|
2643
|
+
/**
|
2644
|
+
* The Amazon Resource Name (ARN) of the prompt.
|
2645
|
+
*/
|
2646
|
+
arn: PromptArn;
|
2647
|
+
/**
|
2648
|
+
* The time at which the prompt was created.
|
2649
|
+
*/
|
2650
|
+
createdAt: DateTimestamp;
|
2651
|
+
/**
|
2652
|
+
* The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
|
2653
|
+
*/
|
2654
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
2655
|
+
/**
|
2656
|
+
* The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
|
2657
|
+
*/
|
2658
|
+
defaultVariant?: PromptVariantName;
|
2659
|
+
/**
|
2660
|
+
* The descriptino of the prompt.
|
2661
|
+
*/
|
2662
|
+
description?: PromptDescription;
|
2663
|
+
/**
|
2664
|
+
* The unique identifier of the prompt.
|
2665
|
+
*/
|
2666
|
+
id: PromptId;
|
2667
|
+
/**
|
2668
|
+
* The name of the prompt.
|
2669
|
+
*/
|
2670
|
+
name: PromptName;
|
2671
|
+
/**
|
2672
|
+
* The time at which the prompt was last updated.
|
2673
|
+
*/
|
2674
|
+
updatedAt: DateTimestamp;
|
2675
|
+
/**
|
2676
|
+
* A list of objects, each containing details about a variant of the prompt.
|
2677
|
+
*/
|
2678
|
+
variants?: PromptVariantList;
|
2679
|
+
/**
|
2680
|
+
* The version of the prompt.
|
2681
|
+
*/
|
2682
|
+
version: Version;
|
2683
|
+
}
|
1485
2684
|
export interface GuardrailConfiguration {
|
1486
2685
|
/**
|
1487
|
-
* The
|
2686
|
+
* The unique identifier of the guardrail.
|
1488
2687
|
*/
|
1489
2688
|
guardrailIdentifier?: GuardrailIdentifier;
|
1490
2689
|
/**
|
1491
|
-
* The
|
2690
|
+
* The version of the guardrail.
|
1492
2691
|
*/
|
1493
2692
|
guardrailVersion?: GuardrailVersion;
|
1494
2693
|
}
|
1495
2694
|
export type GuardrailIdentifier = string;
|
1496
2695
|
export type GuardrailVersion = string;
|
2696
|
+
export interface HierarchicalChunkingConfiguration {
|
2697
|
+
/**
|
2698
|
+
* Token settings for each layer.
|
2699
|
+
*/
|
2700
|
+
levelConfigurations: HierarchicalChunkingLevelConfigurations;
|
2701
|
+
/**
|
2702
|
+
* The number of tokens to repeat across chunks in the same layer.
|
2703
|
+
*/
|
2704
|
+
overlapTokens: HierarchicalChunkingConfigurationOverlapTokensInteger;
|
2705
|
+
}
|
2706
|
+
export type HierarchicalChunkingConfigurationOverlapTokensInteger = number;
|
2707
|
+
export interface HierarchicalChunkingLevelConfiguration {
|
2708
|
+
/**
|
2709
|
+
* The maximum number of tokens that a chunk can contain in this layer.
|
2710
|
+
*/
|
2711
|
+
maxTokens: HierarchicalChunkingLevelConfigurationMaxTokensInteger;
|
2712
|
+
}
|
2713
|
+
export type HierarchicalChunkingLevelConfigurationMaxTokensInteger = number;
|
2714
|
+
export type HierarchicalChunkingLevelConfigurations = HierarchicalChunkingLevelConfiguration[];
|
2715
|
+
export type HttpsUrl = string;
|
1497
2716
|
export type Id = string;
|
1498
2717
|
export interface InferenceConfiguration {
|
1499
2718
|
/**
|
@@ -1651,7 +2870,17 @@ declare namespace BedrockAgent {
|
|
1651
2870
|
*/
|
1652
2871
|
updatedAt: DateTimestamp;
|
1653
2872
|
}
|
2873
|
+
export interface InputFlowNodeConfiguration {
|
2874
|
+
}
|
1654
2875
|
export type Instruction = string;
|
2876
|
+
export interface IntermediateStorage {
|
2877
|
+
/**
|
2878
|
+
* An S3 bucket path.
|
2879
|
+
*/
|
2880
|
+
s3Location: S3Location;
|
2881
|
+
}
|
2882
|
+
export interface IteratorFlowNodeConfiguration {
|
2883
|
+
}
|
1655
2884
|
export type KmsKeyArn = string;
|
1656
2885
|
export interface KnowledgeBase {
|
1657
2886
|
/**
|
@@ -1710,6 +2939,17 @@ declare namespace BedrockAgent {
|
|
1710
2939
|
*/
|
1711
2940
|
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
|
1712
2941
|
}
|
2942
|
+
export interface KnowledgeBaseFlowNodeConfiguration {
|
2943
|
+
/**
|
2944
|
+
* The unique identifier of the knowledge base to query.
|
2945
|
+
*/
|
2946
|
+
knowledgeBaseId: KnowledgeBaseId;
|
2947
|
+
/**
|
2948
|
+
* The unique identifier of the model to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
|
2949
|
+
*/
|
2950
|
+
modelId?: ModelIdentifier;
|
2951
|
+
}
|
2952
|
+
export type KnowledgeBaseId = string;
|
1713
2953
|
export type KnowledgeBaseRoleArn = string;
|
1714
2954
|
export type KnowledgeBaseState = "ENABLED"|"DISABLED"|string;
|
1715
2955
|
export type KnowledgeBaseStatus = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|"FAILED"|"DELETE_UNSUCCESSFUL"|string;
|
@@ -1739,6 +2979,24 @@ declare namespace BedrockAgent {
|
|
1739
2979
|
}
|
1740
2980
|
export type KnowledgeBaseType = "VECTOR"|string;
|
1741
2981
|
export type LambdaArn = string;
|
2982
|
+
export interface LambdaFunctionFlowNodeConfiguration {
|
2983
|
+
/**
|
2984
|
+
* The Amazon Resource Name (ARN) of the Lambda function to invoke.
|
2985
|
+
*/
|
2986
|
+
lambdaArn: LambdaArn;
|
2987
|
+
}
|
2988
|
+
export type LexBotAliasArn = string;
|
2989
|
+
export type LexBotLocaleId = string;
|
2990
|
+
export interface LexFlowNodeConfiguration {
|
2991
|
+
/**
|
2992
|
+
* The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
|
2993
|
+
*/
|
2994
|
+
botAliasArn: LexBotAliasArn;
|
2995
|
+
/**
|
2996
|
+
* The Region to invoke the Amazon Lex bot in.
|
2997
|
+
*/
|
2998
|
+
localeId: LexBotLocaleId;
|
2999
|
+
}
|
1742
3000
|
export interface ListAgentActionGroupsRequest {
|
1743
3001
|
/**
|
1744
3002
|
* The unique identifier of the agent.
|
@@ -1887,6 +3145,74 @@ declare namespace BedrockAgent {
|
|
1887
3145
|
*/
|
1888
3146
|
nextToken?: NextToken;
|
1889
3147
|
}
|
3148
|
+
export interface ListFlowAliasesRequest {
|
3149
|
+
/**
|
3150
|
+
* The unique identifier of the flow for which aliases are being returned.
|
3151
|
+
*/
|
3152
|
+
flowIdentifier: FlowIdentifier;
|
3153
|
+
/**
|
3154
|
+
* 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 nextToken field when making another request to return the next batch of results.
|
3155
|
+
*/
|
3156
|
+
maxResults?: MaxResults;
|
3157
|
+
/**
|
3158
|
+
* If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
|
3159
|
+
*/
|
3160
|
+
nextToken?: NextToken;
|
3161
|
+
}
|
3162
|
+
export interface ListFlowAliasesResponse {
|
3163
|
+
/**
|
3164
|
+
* A list, each member of which contains information about a flow alias.
|
3165
|
+
*/
|
3166
|
+
flowAliasSummaries: FlowAliasSummaries;
|
3167
|
+
/**
|
3168
|
+
* If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
|
3169
|
+
*/
|
3170
|
+
nextToken?: NextToken;
|
3171
|
+
}
|
3172
|
+
export interface ListFlowVersionsRequest {
|
3173
|
+
/**
|
3174
|
+
* The unique identifier of the flow.
|
3175
|
+
*/
|
3176
|
+
flowIdentifier: FlowIdentifier;
|
3177
|
+
/**
|
3178
|
+
* 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 nextToken field when making another request to return the next batch of results.
|
3179
|
+
*/
|
3180
|
+
maxResults?: MaxResults;
|
3181
|
+
/**
|
3182
|
+
* If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
|
3183
|
+
*/
|
3184
|
+
nextToken?: NextToken;
|
3185
|
+
}
|
3186
|
+
export interface ListFlowVersionsResponse {
|
3187
|
+
/**
|
3188
|
+
* A list, each member of which contains information about a flow.
|
3189
|
+
*/
|
3190
|
+
flowVersionSummaries: FlowVersionSummaries;
|
3191
|
+
/**
|
3192
|
+
* If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
|
3193
|
+
*/
|
3194
|
+
nextToken?: NextToken;
|
3195
|
+
}
|
3196
|
+
export interface ListFlowsRequest {
|
3197
|
+
/**
|
3198
|
+
* 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 nextToken field when making another request to return the next batch of results.
|
3199
|
+
*/
|
3200
|
+
maxResults?: MaxResults;
|
3201
|
+
/**
|
3202
|
+
* If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
|
3203
|
+
*/
|
3204
|
+
nextToken?: NextToken;
|
3205
|
+
}
|
3206
|
+
export interface ListFlowsResponse {
|
3207
|
+
/**
|
3208
|
+
* A list, each member of which contains information about a flow.
|
3209
|
+
*/
|
3210
|
+
flowSummaries: FlowSummaries;
|
3211
|
+
/**
|
3212
|
+
* If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
|
3213
|
+
*/
|
3214
|
+
nextToken?: NextToken;
|
3215
|
+
}
|
1890
3216
|
export interface ListIngestionJobsRequest {
|
1891
3217
|
/**
|
1892
3218
|
* The unique identifier of the data source for which to return ingestion jobs.
|
@@ -1943,6 +3269,30 @@ declare namespace BedrockAgent {
|
|
1943
3269
|
*/
|
1944
3270
|
nextToken?: NextToken;
|
1945
3271
|
}
|
3272
|
+
export interface ListPromptsRequest {
|
3273
|
+
/**
|
3274
|
+
* 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 nextToken field when making another request to return the next batch of results.
|
3275
|
+
*/
|
3276
|
+
maxResults?: MaxResults;
|
3277
|
+
/**
|
3278
|
+
* If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
|
3279
|
+
*/
|
3280
|
+
nextToken?: NextToken;
|
3281
|
+
/**
|
3282
|
+
* The unique identifier of the prompt.
|
3283
|
+
*/
|
3284
|
+
promptIdentifier?: PromptIdentifier;
|
3285
|
+
}
|
3286
|
+
export interface ListPromptsResponse {
|
3287
|
+
/**
|
3288
|
+
* If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
|
3289
|
+
*/
|
3290
|
+
nextToken?: NextToken;
|
3291
|
+
/**
|
3292
|
+
* A list, each member of which contains information about a prompt using Prompt management.
|
3293
|
+
*/
|
3294
|
+
promptSummaries: PromptSummaries;
|
3295
|
+
}
|
1946
3296
|
export interface ListTagsForResourceRequest {
|
1947
3297
|
/**
|
1948
3298
|
* The Amazon Resource Name (ARN) of the resource for which to list tags.
|
@@ -1957,6 +3307,18 @@ declare namespace BedrockAgent {
|
|
1957
3307
|
}
|
1958
3308
|
export type MaxResults = number;
|
1959
3309
|
export type MaximumLength = number;
|
3310
|
+
export interface MemoryConfiguration {
|
3311
|
+
/**
|
3312
|
+
* The type of memory that is stored.
|
3313
|
+
*/
|
3314
|
+
enabledMemoryTypes: EnabledMemoryTypes;
|
3315
|
+
/**
|
3316
|
+
* The number of days the agent is configured to retain the conversational context.
|
3317
|
+
*/
|
3318
|
+
storageDays?: StorageDays;
|
3319
|
+
}
|
3320
|
+
export type MemoryType = "SESSION_SUMMARY"|string;
|
3321
|
+
export type Microsoft365TenantId = string;
|
1960
3322
|
export type ModelIdentifier = string;
|
1961
3323
|
export type MongoDbAtlasCollectionName = string;
|
1962
3324
|
export interface MongoDbAtlasConfiguration {
|
@@ -2009,6 +3371,7 @@ declare namespace BedrockAgent {
|
|
2009
3371
|
export type MongoDbAtlasIndexName = string;
|
2010
3372
|
export type Name = string;
|
2011
3373
|
export type NextToken = string;
|
3374
|
+
export type NonBlankString = string;
|
2012
3375
|
export type NumericalVersion = string;
|
2013
3376
|
export type OpenSearchServerlessCollectionArn = string;
|
2014
3377
|
export interface OpenSearchServerlessConfiguration {
|
@@ -2040,6 +3403,8 @@ declare namespace BedrockAgent {
|
|
2040
3403
|
vectorField: FieldName;
|
2041
3404
|
}
|
2042
3405
|
export type OpenSearchServerlessIndexName = string;
|
3406
|
+
export interface OutputFlowNodeConfiguration {
|
3407
|
+
}
|
2043
3408
|
export type ParameterDescription = string;
|
2044
3409
|
export interface ParameterDetail {
|
2045
3410
|
/**
|
@@ -2056,6 +3421,45 @@ declare namespace BedrockAgent {
|
|
2056
3421
|
type: Type;
|
2057
3422
|
}
|
2058
3423
|
export type ParameterMap = {[key: string]: ParameterDetail};
|
3424
|
+
export interface ParsingConfiguration {
|
3425
|
+
/**
|
3426
|
+
* Settings for a foundation model used to parse documents for a data source.
|
3427
|
+
*/
|
3428
|
+
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfiguration;
|
3429
|
+
/**
|
3430
|
+
* The parsing strategy for the data source.
|
3431
|
+
*/
|
3432
|
+
parsingStrategy: ParsingStrategy;
|
3433
|
+
}
|
3434
|
+
export interface ParsingPrompt {
|
3435
|
+
/**
|
3436
|
+
* Instructions for interpreting the contents of a document.
|
3437
|
+
*/
|
3438
|
+
parsingPromptText: ParsingPromptText;
|
3439
|
+
}
|
3440
|
+
export type ParsingPromptText = string;
|
3441
|
+
export type ParsingStrategy = "BEDROCK_FOUNDATION_MODEL"|string;
|
3442
|
+
export interface PatternObjectFilter {
|
3443
|
+
/**
|
3444
|
+
* A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
|
3445
|
+
*/
|
3446
|
+
exclusionFilters?: FilterList;
|
3447
|
+
/**
|
3448
|
+
* A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
|
3449
|
+
*/
|
3450
|
+
inclusionFilters?: FilterList;
|
3451
|
+
/**
|
3452
|
+
* The supported object type or content type of the data source.
|
3453
|
+
*/
|
3454
|
+
objectType: FilteredObjectType;
|
3455
|
+
}
|
3456
|
+
export interface PatternObjectFilterConfiguration {
|
3457
|
+
/**
|
3458
|
+
* The configuration of specific filters applied to your data source content. You can filter out or include certain content.
|
3459
|
+
*/
|
3460
|
+
filters: PatternObjectFilterList;
|
3461
|
+
}
|
3462
|
+
export type PatternObjectFilterList = PatternObjectFilter[];
|
2059
3463
|
export type Payload = string;
|
2060
3464
|
export interface PineconeConfiguration {
|
2061
3465
|
/**
|
@@ -2111,46 +3515,206 @@ declare namespace BedrockAgent {
|
|
2111
3515
|
*/
|
2112
3516
|
preparedAt: DateTimestamp;
|
2113
3517
|
}
|
3518
|
+
export interface PrepareFlowRequest {
|
3519
|
+
/**
|
3520
|
+
* The unique identifier of the flow.
|
3521
|
+
*/
|
3522
|
+
flowIdentifier: FlowIdentifier;
|
3523
|
+
}
|
3524
|
+
export interface PrepareFlowResponse {
|
3525
|
+
/**
|
3526
|
+
* The unique identifier of the flow.
|
3527
|
+
*/
|
3528
|
+
id: FlowId;
|
3529
|
+
/**
|
3530
|
+
* The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.
|
3531
|
+
*/
|
3532
|
+
status: FlowStatus;
|
3533
|
+
}
|
2114
3534
|
export type PrimitiveLong = number;
|
3535
|
+
export type PromptArn = string;
|
2115
3536
|
export interface PromptConfiguration {
|
2116
3537
|
/**
|
2117
|
-
* 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 Prompt template placeholder variables. For more information, see Configure the prompt templates.
|
3538
|
+
* 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 Prompt template placeholder variables. For more information, see Configure the prompt templates.
|
3539
|
+
*/
|
3540
|
+
basePromptTemplate?: BasePromptTemplate;
|
3541
|
+
/**
|
3542
|
+
* Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
|
3543
|
+
*/
|
3544
|
+
inferenceConfiguration?: InferenceConfiguration;
|
3545
|
+
/**
|
3546
|
+
* 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 promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
|
3547
|
+
*/
|
3548
|
+
parserMode?: CreationMode;
|
3549
|
+
/**
|
3550
|
+
* Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
|
3551
|
+
*/
|
3552
|
+
promptCreationMode?: CreationMode;
|
3553
|
+
/**
|
3554
|
+
* Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows. PRE_PROCESSING – ENABLED ORCHESTRATION – ENABLED KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED POST_PROCESSING – DISABLED
|
3555
|
+
*/
|
3556
|
+
promptState?: PromptState;
|
3557
|
+
/**
|
3558
|
+
* The step in the agent sequence that this prompt configuration applies to.
|
3559
|
+
*/
|
3560
|
+
promptType?: PromptType;
|
3561
|
+
}
|
3562
|
+
export type PromptConfigurations = PromptConfiguration[];
|
3563
|
+
export type PromptDescription = string;
|
3564
|
+
export interface PromptFlowNodeConfiguration {
|
3565
|
+
/**
|
3566
|
+
* Specifies whether the prompt is from Prompt management or defined inline.
|
3567
|
+
*/
|
3568
|
+
sourceConfiguration: PromptFlowNodeSourceConfiguration;
|
3569
|
+
}
|
3570
|
+
export interface PromptFlowNodeInlineConfiguration {
|
3571
|
+
/**
|
3572
|
+
* Contains inference configurations for the prompt.
|
3573
|
+
*/
|
3574
|
+
inferenceConfiguration?: PromptInferenceConfiguration;
|
3575
|
+
/**
|
3576
|
+
* The unique identifier of the model to run inference with.
|
3577
|
+
*/
|
3578
|
+
modelId: PromptModelIdentifier;
|
3579
|
+
/**
|
3580
|
+
* Contains a prompt and variables in the prompt that can be replaced with values at runtime.
|
3581
|
+
*/
|
3582
|
+
templateConfiguration: PromptTemplateConfiguration;
|
3583
|
+
/**
|
3584
|
+
* The type of prompt template.
|
3585
|
+
*/
|
3586
|
+
templateType: PromptTemplateType;
|
3587
|
+
}
|
3588
|
+
export interface PromptFlowNodeResourceConfiguration {
|
3589
|
+
/**
|
3590
|
+
* The Amazon Resource Name (ARN) of the prompt from Prompt management.
|
3591
|
+
*/
|
3592
|
+
promptArn: PromptArn;
|
3593
|
+
}
|
3594
|
+
export interface PromptFlowNodeSourceConfiguration {
|
3595
|
+
/**
|
3596
|
+
* Contains configurations for a prompt that is defined inline
|
3597
|
+
*/
|
3598
|
+
inline?: PromptFlowNodeInlineConfiguration;
|
3599
|
+
/**
|
3600
|
+
* Contains configurations for a prompt from Prompt management.
|
3601
|
+
*/
|
3602
|
+
resource?: PromptFlowNodeResourceConfiguration;
|
3603
|
+
}
|
3604
|
+
export type PromptId = string;
|
3605
|
+
export type PromptIdentifier = string;
|
3606
|
+
export interface PromptInferenceConfiguration {
|
3607
|
+
/**
|
3608
|
+
* Contains inference configurations for a text prompt.
|
3609
|
+
*/
|
3610
|
+
text?: PromptModelInferenceConfiguration;
|
3611
|
+
}
|
3612
|
+
export interface PromptInputVariable {
|
3613
|
+
/**
|
3614
|
+
* The name of the variable.
|
3615
|
+
*/
|
3616
|
+
name?: PromptInputVariableName;
|
3617
|
+
}
|
3618
|
+
export type PromptInputVariableName = string;
|
3619
|
+
export type PromptInputVariablesList = PromptInputVariable[];
|
3620
|
+
export type PromptModelIdentifier = string;
|
3621
|
+
export interface PromptModelInferenceConfiguration {
|
3622
|
+
/**
|
3623
|
+
* The maximum number of tokens to return in the response.
|
3624
|
+
*/
|
3625
|
+
maxTokens?: MaximumLength;
|
3626
|
+
/**
|
3627
|
+
* A list of strings that define sequences after which the model will stop generating.
|
3628
|
+
*/
|
3629
|
+
stopSequences?: StopSequences;
|
3630
|
+
/**
|
3631
|
+
* Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
|
3632
|
+
*/
|
3633
|
+
temperature?: Temperature;
|
3634
|
+
/**
|
3635
|
+
* The number of most-likely candidates that the model considers for the next token during generation.
|
3636
|
+
*/
|
3637
|
+
topK?: TopK;
|
3638
|
+
/**
|
3639
|
+
* The percentage of most-likely candidates that the model considers for the next token.
|
3640
|
+
*/
|
3641
|
+
topP?: TopP;
|
3642
|
+
}
|
3643
|
+
export type PromptName = string;
|
3644
|
+
export interface PromptOverrideConfiguration {
|
3645
|
+
/**
|
3646
|
+
* 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 promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.
|
3647
|
+
*/
|
3648
|
+
overrideLambda?: LambdaArn;
|
3649
|
+
/**
|
3650
|
+
* Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
|
3651
|
+
*/
|
3652
|
+
promptConfigurations: PromptConfigurations;
|
3653
|
+
}
|
3654
|
+
export type PromptState = "ENABLED"|"DISABLED"|string;
|
3655
|
+
export type PromptSummaries = PromptSummary[];
|
3656
|
+
export interface PromptSummary {
|
3657
|
+
/**
|
3658
|
+
* The Amazon Resource Name (ARN) of the prompt.
|
3659
|
+
*/
|
3660
|
+
arn: PromptArn;
|
3661
|
+
/**
|
3662
|
+
* The time at which the prompt was created.
|
3663
|
+
*/
|
3664
|
+
createdAt: DateTimestamp;
|
3665
|
+
/**
|
3666
|
+
* The description of the prompt.
|
3667
|
+
*/
|
3668
|
+
description?: PromptDescription;
|
3669
|
+
/**
|
3670
|
+
* The unique identifier of the prompt.
|
3671
|
+
*/
|
3672
|
+
id: PromptId;
|
3673
|
+
/**
|
3674
|
+
* The name of the prompt.
|
2118
3675
|
*/
|
2119
|
-
|
3676
|
+
name: PromptName;
|
2120
3677
|
/**
|
2121
|
-
*
|
3678
|
+
* The time at which the prompt was last updated.
|
2122
3679
|
*/
|
2123
|
-
|
3680
|
+
updatedAt: DateTimestamp;
|
2124
3681
|
/**
|
2125
|
-
*
|
3682
|
+
* The version of the prompt that this summary applies to.
|
2126
3683
|
*/
|
2127
|
-
|
3684
|
+
version: Version;
|
3685
|
+
}
|
3686
|
+
export interface PromptTemplateConfiguration {
|
2128
3687
|
/**
|
2129
|
-
*
|
3688
|
+
* Contains configurations for the text in a message for a prompt.
|
2130
3689
|
*/
|
2131
|
-
|
3690
|
+
text?: TextPromptTemplateConfiguration;
|
3691
|
+
}
|
3692
|
+
export type PromptTemplateType = "TEXT"|string;
|
3693
|
+
export type PromptType = "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|string;
|
3694
|
+
export interface PromptVariant {
|
2132
3695
|
/**
|
2133
|
-
*
|
3696
|
+
* Contains inference configurations for the prompt variant.
|
2134
3697
|
*/
|
2135
|
-
|
3698
|
+
inferenceConfiguration?: PromptInferenceConfiguration;
|
2136
3699
|
/**
|
2137
|
-
* The
|
3700
|
+
* The unique identifier of the model with which to run inference on the prompt.
|
2138
3701
|
*/
|
2139
|
-
|
2140
|
-
}
|
2141
|
-
export type PromptConfigurations = PromptConfiguration[];
|
2142
|
-
export interface PromptOverrideConfiguration {
|
3702
|
+
modelId?: PromptModelIdentifier;
|
2143
3703
|
/**
|
2144
|
-
* The
|
3704
|
+
* The name of the prompt variant.
|
2145
3705
|
*/
|
2146
|
-
|
3706
|
+
name: PromptVariantName;
|
2147
3707
|
/**
|
2148
|
-
* Contains configurations
|
3708
|
+
* Contains configurations for the prompt template.
|
2149
3709
|
*/
|
2150
|
-
|
3710
|
+
templateConfiguration?: PromptTemplateConfiguration;
|
3711
|
+
/**
|
3712
|
+
* The type of prompt template to use.
|
3713
|
+
*/
|
3714
|
+
templateType: PromptTemplateType;
|
2151
3715
|
}
|
2152
|
-
export type
|
2153
|
-
export type
|
3716
|
+
export type PromptVariantList = PromptVariant[];
|
3717
|
+
export type PromptVariantName = string;
|
2154
3718
|
export type ProvisionedModelIdentifier = string;
|
2155
3719
|
export type RdsArn = string;
|
2156
3720
|
export interface RdsConfiguration {
|
@@ -2231,19 +3795,38 @@ declare namespace BedrockAgent {
|
|
2231
3795
|
vectorField: FieldName;
|
2232
3796
|
}
|
2233
3797
|
export type RedisEnterpriseCloudIndexName = string;
|
3798
|
+
export interface RetrievalFlowNodeConfiguration {
|
3799
|
+
/**
|
3800
|
+
* Contains configurations for the service to use for retrieving data to return as the output from the node.
|
3801
|
+
*/
|
3802
|
+
serviceConfiguration: RetrievalFlowNodeServiceConfiguration;
|
3803
|
+
}
|
3804
|
+
export interface RetrievalFlowNodeS3Configuration {
|
3805
|
+
/**
|
3806
|
+
* The name of the Amazon S3 bucket from which to retrieve data.
|
3807
|
+
*/
|
3808
|
+
bucketName: S3BucketName;
|
3809
|
+
}
|
3810
|
+
export interface RetrievalFlowNodeServiceConfiguration {
|
3811
|
+
/**
|
3812
|
+
* Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
|
3813
|
+
*/
|
3814
|
+
s3?: RetrievalFlowNodeS3Configuration;
|
3815
|
+
}
|
2234
3816
|
export type S3BucketArn = string;
|
2235
3817
|
export type S3BucketName = string;
|
3818
|
+
export type S3BucketUri = string;
|
2236
3819
|
export interface S3DataSourceConfiguration {
|
2237
3820
|
/**
|
2238
|
-
* The Amazon Resource Name (ARN) of the bucket that contains
|
3821
|
+
* The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
|
2239
3822
|
*/
|
2240
3823
|
bucketArn: S3BucketArn;
|
2241
3824
|
/**
|
2242
|
-
* The
|
3825
|
+
* The account ID for the owner of the S3 bucket.
|
2243
3826
|
*/
|
2244
3827
|
bucketOwnerAccountId?: BucketOwnerAccountId;
|
2245
3828
|
/**
|
2246
|
-
* A list of S3 prefixes
|
3829
|
+
* A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.
|
2247
3830
|
*/
|
2248
3831
|
inclusionPrefixes?: S3Prefixes;
|
2249
3832
|
}
|
@@ -2253,14 +3836,75 @@ declare namespace BedrockAgent {
|
|
2253
3836
|
*/
|
2254
3837
|
s3BucketName?: S3BucketName;
|
2255
3838
|
/**
|
2256
|
-
* The S3 object key
|
3839
|
+
* The S3 object key for the S3 resource.
|
2257
3840
|
*/
|
2258
3841
|
s3ObjectKey?: S3ObjectKey;
|
2259
3842
|
}
|
3843
|
+
export interface S3Location {
|
3844
|
+
/**
|
3845
|
+
* The location's URI. For example, s3://my-bucket/chunk-processor/.
|
3846
|
+
*/
|
3847
|
+
uri: S3BucketUri;
|
3848
|
+
}
|
2260
3849
|
export type S3ObjectKey = string;
|
2261
3850
|
export type S3Prefix = string;
|
2262
3851
|
export type S3Prefixes = S3Prefix[];
|
3852
|
+
export type SalesforceAuthType = "OAUTH2_CLIENT_CREDENTIALS"|string;
|
3853
|
+
export interface SalesforceCrawlerConfiguration {
|
3854
|
+
/**
|
3855
|
+
* The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.
|
3856
|
+
*/
|
3857
|
+
filterConfiguration?: CrawlFilterConfiguration;
|
3858
|
+
}
|
3859
|
+
export interface SalesforceDataSourceConfiguration {
|
3860
|
+
/**
|
3861
|
+
* The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
|
3862
|
+
*/
|
3863
|
+
crawlerConfiguration?: SalesforceCrawlerConfiguration;
|
3864
|
+
/**
|
3865
|
+
* The endpoint information to connect to your Salesforce data source.
|
3866
|
+
*/
|
3867
|
+
sourceConfiguration: SalesforceSourceConfiguration;
|
3868
|
+
}
|
3869
|
+
export interface SalesforceSourceConfiguration {
|
3870
|
+
/**
|
3871
|
+
* The supported authentication type to authenticate and connect to your Salesforce instance.
|
3872
|
+
*/
|
3873
|
+
authType: SalesforceAuthType;
|
3874
|
+
/**
|
3875
|
+
* The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.
|
3876
|
+
*/
|
3877
|
+
credentialsSecretArn: SecretArn;
|
3878
|
+
/**
|
3879
|
+
* The Salesforce host URL or instance URL.
|
3880
|
+
*/
|
3881
|
+
hostUrl: HttpsUrl;
|
3882
|
+
}
|
2263
3883
|
export type SecretArn = string;
|
3884
|
+
export interface SeedUrl {
|
3885
|
+
/**
|
3886
|
+
* A seed or starting point URL.
|
3887
|
+
*/
|
3888
|
+
url?: Url;
|
3889
|
+
}
|
3890
|
+
export type SeedUrls = SeedUrl[];
|
3891
|
+
export interface SemanticChunkingConfiguration {
|
3892
|
+
/**
|
3893
|
+
* The dissimilarity threshold for splitting chunks.
|
3894
|
+
*/
|
3895
|
+
breakpointPercentileThreshold: SemanticChunkingConfigurationBreakpointPercentileThresholdInteger;
|
3896
|
+
/**
|
3897
|
+
* The buffer size.
|
3898
|
+
*/
|
3899
|
+
bufferSize: SemanticChunkingConfigurationBufferSizeInteger;
|
3900
|
+
/**
|
3901
|
+
* The maximum number of tokens that a chunk can contain.
|
3902
|
+
*/
|
3903
|
+
maxTokens: SemanticChunkingConfigurationMaxTokensInteger;
|
3904
|
+
}
|
3905
|
+
export type SemanticChunkingConfigurationBreakpointPercentileThresholdInteger = number;
|
3906
|
+
export type SemanticChunkingConfigurationBufferSizeInteger = number;
|
3907
|
+
export type SemanticChunkingConfigurationMaxTokensInteger = number;
|
2264
3908
|
export interface ServerSideEncryptionConfiguration {
|
2265
3909
|
/**
|
2266
3910
|
* The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
|
@@ -2268,6 +3912,52 @@ declare namespace BedrockAgent {
|
|
2268
3912
|
kmsKeyArn?: KmsKeyArn;
|
2269
3913
|
}
|
2270
3914
|
export type SessionTTL = number;
|
3915
|
+
export type SharePointAuthType = "OAUTH2_CLIENT_CREDENTIALS"|string;
|
3916
|
+
export interface SharePointCrawlerConfiguration {
|
3917
|
+
/**
|
3918
|
+
* The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.
|
3919
|
+
*/
|
3920
|
+
filterConfiguration?: CrawlFilterConfiguration;
|
3921
|
+
}
|
3922
|
+
export interface SharePointDataSourceConfiguration {
|
3923
|
+
/**
|
3924
|
+
* The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
|
3925
|
+
*/
|
3926
|
+
crawlerConfiguration?: SharePointCrawlerConfiguration;
|
3927
|
+
/**
|
3928
|
+
* The endpoint information to connect to your SharePoint data source.
|
3929
|
+
*/
|
3930
|
+
sourceConfiguration: SharePointSourceConfiguration;
|
3931
|
+
}
|
3932
|
+
export type SharePointDomain = string;
|
3933
|
+
export type SharePointHostType = "ONLINE"|string;
|
3934
|
+
export type SharePointSiteUrls = HttpsUrl[];
|
3935
|
+
export interface SharePointSourceConfiguration {
|
3936
|
+
/**
|
3937
|
+
* The supported authentication type to authenticate and connect to your SharePoint site/sites.
|
3938
|
+
*/
|
3939
|
+
authType: SharePointAuthType;
|
3940
|
+
/**
|
3941
|
+
* The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.
|
3942
|
+
*/
|
3943
|
+
credentialsSecretArn: SecretArn;
|
3944
|
+
/**
|
3945
|
+
* The domain of your SharePoint instance or site URL/URLs.
|
3946
|
+
*/
|
3947
|
+
domain: SharePointDomain;
|
3948
|
+
/**
|
3949
|
+
* The supported host type, whether online/cloud or server/on-premises.
|
3950
|
+
*/
|
3951
|
+
hostType: SharePointHostType;
|
3952
|
+
/**
|
3953
|
+
* A list of one or more SharePoint site URLs.
|
3954
|
+
*/
|
3955
|
+
siteUrls: SharePointSiteUrls;
|
3956
|
+
/**
|
3957
|
+
* The identifier of your Microsoft 365 tenant.
|
3958
|
+
*/
|
3959
|
+
tenantId?: Microsoft365TenantId;
|
3960
|
+
}
|
2271
3961
|
export type SortOrder = "ASCENDING"|"DESCENDING"|string;
|
2272
3962
|
export interface StartIngestionJobRequest {
|
2273
3963
|
/**
|
@@ -2293,6 +3983,7 @@ declare namespace BedrockAgent {
|
|
2293
3983
|
*/
|
2294
3984
|
ingestionJob: IngestionJob;
|
2295
3985
|
}
|
3986
|
+
export type StepType = "POST_CHUNKING"|string;
|
2296
3987
|
export type StopSequences = String[];
|
2297
3988
|
export interface StorageConfiguration {
|
2298
3989
|
/**
|
@@ -2320,6 +4011,25 @@ declare namespace BedrockAgent {
|
|
2320
4011
|
*/
|
2321
4012
|
type: KnowledgeBaseStorageType;
|
2322
4013
|
}
|
4014
|
+
export type StorageDays = number;
|
4015
|
+
export interface StorageFlowNodeConfiguration {
|
4016
|
+
/**
|
4017
|
+
* Contains configurations for the service to use for storing the input into the node.
|
4018
|
+
*/
|
4019
|
+
serviceConfiguration: StorageFlowNodeServiceConfiguration;
|
4020
|
+
}
|
4021
|
+
export interface StorageFlowNodeS3Configuration {
|
4022
|
+
/**
|
4023
|
+
* The name of the Amazon S3 bucket in which to store the input into the node.
|
4024
|
+
*/
|
4025
|
+
bucketName: S3BucketName;
|
4026
|
+
}
|
4027
|
+
export interface StorageFlowNodeServiceConfiguration {
|
4028
|
+
/**
|
4029
|
+
* Contains configurations for the Amazon S3 location in which to store the input into the node.
|
4030
|
+
*/
|
4031
|
+
s3?: StorageFlowNodeS3Configuration;
|
4032
|
+
}
|
2323
4033
|
export type String = string;
|
2324
4034
|
export type TagKey = string;
|
2325
4035
|
export type TagKeyList = TagKey[];
|
@@ -2339,8 +4049,42 @@ declare namespace BedrockAgent {
|
|
2339
4049
|
export type TaggableResourcesArn = string;
|
2340
4050
|
export type TagsMap = {[key: string]: TagValue};
|
2341
4051
|
export type Temperature = number;
|
4052
|
+
export type TextPrompt = string;
|
4053
|
+
export interface TextPromptTemplateConfiguration {
|
4054
|
+
/**
|
4055
|
+
* An array of the variables in the prompt template.
|
4056
|
+
*/
|
4057
|
+
inputVariables?: PromptInputVariablesList;
|
4058
|
+
/**
|
4059
|
+
* The message for the prompt.
|
4060
|
+
*/
|
4061
|
+
text: TextPrompt;
|
4062
|
+
}
|
2342
4063
|
export type TopK = number;
|
2343
4064
|
export type TopP = number;
|
4065
|
+
export interface Transformation {
|
4066
|
+
/**
|
4067
|
+
* When the service applies the transformation.
|
4068
|
+
*/
|
4069
|
+
stepToApply: StepType;
|
4070
|
+
/**
|
4071
|
+
* A Lambda function that processes documents.
|
4072
|
+
*/
|
4073
|
+
transformationFunction: TransformationFunction;
|
4074
|
+
}
|
4075
|
+
export interface TransformationFunction {
|
4076
|
+
/**
|
4077
|
+
* The Lambda function.
|
4078
|
+
*/
|
4079
|
+
transformationLambdaConfiguration: TransformationLambdaConfiguration;
|
4080
|
+
}
|
4081
|
+
export interface TransformationLambdaConfiguration {
|
4082
|
+
/**
|
4083
|
+
* The function's ARN identifier.
|
4084
|
+
*/
|
4085
|
+
lambdaArn: LambdaArn;
|
4086
|
+
}
|
4087
|
+
export type Transformations = Transformation[];
|
2344
4088
|
export type Type = "string"|"number"|"integer"|"boolean"|"array"|string;
|
2345
4089
|
export interface UntagResourceRequest {
|
2346
4090
|
/**
|
@@ -2495,6 +4239,10 @@ declare namespace BedrockAgent {
|
|
2495
4239
|
* Specifies new instructions that tell the agent what it should do and how it should interact with users.
|
2496
4240
|
*/
|
2497
4241
|
instruction?: Instruction;
|
4242
|
+
/**
|
4243
|
+
* Specifies the new memory configuration for the agent.
|
4244
|
+
*/
|
4245
|
+
memoryConfiguration?: MemoryConfiguration;
|
2498
4246
|
/**
|
2499
4247
|
* Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
|
2500
4248
|
*/
|
@@ -2508,11 +4256,11 @@ declare namespace BedrockAgent {
|
|
2508
4256
|
}
|
2509
4257
|
export interface UpdateDataSourceRequest {
|
2510
4258
|
/**
|
2511
|
-
* The data deletion policy
|
4259
|
+
* The data deletion policy for the data source that you want to update.
|
2512
4260
|
*/
|
2513
4261
|
dataDeletionPolicy?: DataDeletionPolicy;
|
2514
4262
|
/**
|
2515
|
-
*
|
4263
|
+
* The connection configuration for the data source that you want to update.
|
2516
4264
|
*/
|
2517
4265
|
dataSourceConfiguration: DataSourceConfiguration;
|
2518
4266
|
/**
|
@@ -2524,7 +4272,7 @@ declare namespace BedrockAgent {
|
|
2524
4272
|
*/
|
2525
4273
|
description?: Description;
|
2526
4274
|
/**
|
2527
|
-
* The unique identifier of the knowledge base
|
4275
|
+
* The unique identifier of the knowledge base for the data source.
|
2528
4276
|
*/
|
2529
4277
|
knowledgeBaseId: Id;
|
2530
4278
|
/**
|
@@ -2546,6 +4294,134 @@ declare namespace BedrockAgent {
|
|
2546
4294
|
*/
|
2547
4295
|
dataSource: DataSource;
|
2548
4296
|
}
|
4297
|
+
export interface UpdateFlowAliasRequest {
|
4298
|
+
/**
|
4299
|
+
* The unique identifier of the alias.
|
4300
|
+
*/
|
4301
|
+
aliasIdentifier: FlowAliasIdentifier;
|
4302
|
+
/**
|
4303
|
+
* A description for the flow alias.
|
4304
|
+
*/
|
4305
|
+
description?: Description;
|
4306
|
+
/**
|
4307
|
+
* The unique identifier of the flow.
|
4308
|
+
*/
|
4309
|
+
flowIdentifier: FlowIdentifier;
|
4310
|
+
/**
|
4311
|
+
* The name of the flow alias.
|
4312
|
+
*/
|
4313
|
+
name: Name;
|
4314
|
+
/**
|
4315
|
+
* Contains information about the version to which to map the alias.
|
4316
|
+
*/
|
4317
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
4318
|
+
}
|
4319
|
+
export interface UpdateFlowAliasResponse {
|
4320
|
+
/**
|
4321
|
+
* The Amazon Resource Name (ARN) of the flow.
|
4322
|
+
*/
|
4323
|
+
arn: FlowAliasArn;
|
4324
|
+
/**
|
4325
|
+
* The time at which the flow was created.
|
4326
|
+
*/
|
4327
|
+
createdAt: DateTimestamp;
|
4328
|
+
/**
|
4329
|
+
* The description of the flow.
|
4330
|
+
*/
|
4331
|
+
description?: Description;
|
4332
|
+
/**
|
4333
|
+
* The unique identifier of the flow.
|
4334
|
+
*/
|
4335
|
+
flowId: FlowId;
|
4336
|
+
/**
|
4337
|
+
* The unique identifier of the alias.
|
4338
|
+
*/
|
4339
|
+
id: FlowAliasId;
|
4340
|
+
/**
|
4341
|
+
* The name of the flow alias.
|
4342
|
+
*/
|
4343
|
+
name: Name;
|
4344
|
+
/**
|
4345
|
+
* Contains information about the version that the alias is mapped to.
|
4346
|
+
*/
|
4347
|
+
routingConfiguration: FlowAliasRoutingConfiguration;
|
4348
|
+
/**
|
4349
|
+
* The time at which the flow alias was last updated.
|
4350
|
+
*/
|
4351
|
+
updatedAt: DateTimestamp;
|
4352
|
+
}
|
4353
|
+
export interface UpdateFlowRequest {
|
4354
|
+
/**
|
4355
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
|
4356
|
+
*/
|
4357
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
4358
|
+
/**
|
4359
|
+
* A definition of the nodes and the connections between the nodes in the flow.
|
4360
|
+
*/
|
4361
|
+
definition?: FlowDefinition;
|
4362
|
+
/**
|
4363
|
+
* A description for the flow.
|
4364
|
+
*/
|
4365
|
+
description?: FlowDescription;
|
4366
|
+
/**
|
4367
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
4368
|
+
*/
|
4369
|
+
executionRoleArn: FlowExecutionRoleArn;
|
4370
|
+
/**
|
4371
|
+
* The unique identifier of the flow.
|
4372
|
+
*/
|
4373
|
+
flowIdentifier: FlowIdentifier;
|
4374
|
+
/**
|
4375
|
+
* A name for the flow.
|
4376
|
+
*/
|
4377
|
+
name: FlowName;
|
4378
|
+
}
|
4379
|
+
export interface UpdateFlowResponse {
|
4380
|
+
/**
|
4381
|
+
* The Amazon Resource Name (ARN) of the flow.
|
4382
|
+
*/
|
4383
|
+
arn: FlowArn;
|
4384
|
+
/**
|
4385
|
+
* The time at which the flow was created.
|
4386
|
+
*/
|
4387
|
+
createdAt: DateTimestamp;
|
4388
|
+
/**
|
4389
|
+
* The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
|
4390
|
+
*/
|
4391
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
4392
|
+
/**
|
4393
|
+
* A definition of the nodes and the connections between nodes in the flow.
|
4394
|
+
*/
|
4395
|
+
definition?: FlowDefinition;
|
4396
|
+
/**
|
4397
|
+
* The description of the flow.
|
4398
|
+
*/
|
4399
|
+
description?: FlowDescription;
|
4400
|
+
/**
|
4401
|
+
* The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.
|
4402
|
+
*/
|
4403
|
+
executionRoleArn: FlowExecutionRoleArn;
|
4404
|
+
/**
|
4405
|
+
* The unique identifier of the flow.
|
4406
|
+
*/
|
4407
|
+
id: FlowId;
|
4408
|
+
/**
|
4409
|
+
* The name of the flow.
|
4410
|
+
*/
|
4411
|
+
name: FlowName;
|
4412
|
+
/**
|
4413
|
+
* The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.
|
4414
|
+
*/
|
4415
|
+
status: FlowStatus;
|
4416
|
+
/**
|
4417
|
+
* The time at which the flow was last updated.
|
4418
|
+
*/
|
4419
|
+
updatedAt: DateTimestamp;
|
4420
|
+
/**
|
4421
|
+
* The version of the flow. When you update a flow, the version updated is the DRAFT version.
|
4422
|
+
*/
|
4423
|
+
version: DraftVersion;
|
4424
|
+
}
|
2549
4425
|
export interface UpdateKnowledgeBaseRequest {
|
2550
4426
|
/**
|
2551
4427
|
* Specifies a new description for the knowledge base.
|
@@ -2578,11 +4454,94 @@ declare namespace BedrockAgent {
|
|
2578
4454
|
*/
|
2579
4455
|
knowledgeBase: KnowledgeBase;
|
2580
4456
|
}
|
4457
|
+
export interface UpdatePromptRequest {
|
4458
|
+
/**
|
4459
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
|
4460
|
+
*/
|
4461
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
4462
|
+
/**
|
4463
|
+
* The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
|
4464
|
+
*/
|
4465
|
+
defaultVariant?: PromptVariantName;
|
4466
|
+
/**
|
4467
|
+
* A description for the prompt.
|
4468
|
+
*/
|
4469
|
+
description?: PromptDescription;
|
4470
|
+
/**
|
4471
|
+
* A name for the prompt.
|
4472
|
+
*/
|
4473
|
+
name: PromptName;
|
4474
|
+
/**
|
4475
|
+
* The unique identifier of the prompt.
|
4476
|
+
*/
|
4477
|
+
promptIdentifier: PromptIdentifier;
|
4478
|
+
/**
|
4479
|
+
* A list of objects, each containing details about a variant of the prompt.
|
4480
|
+
*/
|
4481
|
+
variants?: PromptVariantList;
|
4482
|
+
}
|
4483
|
+
export interface UpdatePromptResponse {
|
4484
|
+
/**
|
4485
|
+
* The Amazon Resource Name (ARN) of the prompt.
|
4486
|
+
*/
|
4487
|
+
arn: PromptArn;
|
4488
|
+
/**
|
4489
|
+
* The time at which the prompt was created.
|
4490
|
+
*/
|
4491
|
+
createdAt: DateTimestamp;
|
4492
|
+
/**
|
4493
|
+
* The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
|
4494
|
+
*/
|
4495
|
+
customerEncryptionKeyArn?: KmsKeyArn;
|
4496
|
+
/**
|
4497
|
+
* The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
|
4498
|
+
*/
|
4499
|
+
defaultVariant?: PromptVariantName;
|
4500
|
+
/**
|
4501
|
+
* The description of the prompt.
|
4502
|
+
*/
|
4503
|
+
description?: PromptDescription;
|
4504
|
+
/**
|
4505
|
+
* The unique identifier of the prompt.
|
4506
|
+
*/
|
4507
|
+
id: PromptId;
|
4508
|
+
/**
|
4509
|
+
* The name of the prompt.
|
4510
|
+
*/
|
4511
|
+
name: PromptName;
|
4512
|
+
/**
|
4513
|
+
* The time at which the prompt was last updated.
|
4514
|
+
*/
|
4515
|
+
updatedAt: DateTimestamp;
|
4516
|
+
/**
|
4517
|
+
* A list of objects, each containing details about a variant of the prompt.
|
4518
|
+
*/
|
4519
|
+
variants?: PromptVariantList;
|
4520
|
+
/**
|
4521
|
+
* The version of the prompt. When you update a prompt, the version updated is the DRAFT version.
|
4522
|
+
*/
|
4523
|
+
version: Version;
|
4524
|
+
}
|
4525
|
+
export type Url = string;
|
4526
|
+
export interface UrlConfiguration {
|
4527
|
+
/**
|
4528
|
+
* One or more seed or starting point URLs.
|
4529
|
+
*/
|
4530
|
+
seedUrls?: SeedUrls;
|
4531
|
+
}
|
2581
4532
|
export interface VectorIngestionConfiguration {
|
2582
4533
|
/**
|
2583
4534
|
* Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
|
2584
4535
|
*/
|
2585
4536
|
chunkingConfiguration?: ChunkingConfiguration;
|
4537
|
+
/**
|
4538
|
+
* A custom document transformer for parsed data source documents.
|
4539
|
+
*/
|
4540
|
+
customTransformationConfiguration?: CustomTransformationConfiguration;
|
4541
|
+
/**
|
4542
|
+
* A custom parser for data source documents.
|
4543
|
+
*/
|
4544
|
+
parsingConfiguration?: ParsingConfiguration;
|
2586
4545
|
}
|
2587
4546
|
export interface VectorKnowledgeBaseConfiguration {
|
2588
4547
|
/**
|
@@ -2595,6 +4554,48 @@ declare namespace BedrockAgent {
|
|
2595
4554
|
embeddingModelConfiguration?: EmbeddingModelConfiguration;
|
2596
4555
|
}
|
2597
4556
|
export type Version = string;
|
4557
|
+
export interface WebCrawlerConfiguration {
|
4558
|
+
/**
|
4559
|
+
* The configuration of crawl limits for the web URLs.
|
4560
|
+
*/
|
4561
|
+
crawlerLimits?: WebCrawlerLimits;
|
4562
|
+
/**
|
4563
|
+
* A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
|
4564
|
+
*/
|
4565
|
+
exclusionFilters?: FilterList;
|
4566
|
+
/**
|
4567
|
+
* A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
|
4568
|
+
*/
|
4569
|
+
inclusionFilters?: FilterList;
|
4570
|
+
/**
|
4571
|
+
* The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
|
4572
|
+
*/
|
4573
|
+
scope?: WebScopeType;
|
4574
|
+
}
|
4575
|
+
export interface WebCrawlerLimits {
|
4576
|
+
/**
|
4577
|
+
* The max rate at which pages are crawled, up to 300 per minute per host.
|
4578
|
+
*/
|
4579
|
+
rateLimit?: WebCrawlerLimitsRateLimitInteger;
|
4580
|
+
}
|
4581
|
+
export type WebCrawlerLimitsRateLimitInteger = number;
|
4582
|
+
export interface WebDataSourceConfiguration {
|
4583
|
+
/**
|
4584
|
+
* The Web Crawler configuration details for the web data source.
|
4585
|
+
*/
|
4586
|
+
crawlerConfiguration?: WebCrawlerConfiguration;
|
4587
|
+
/**
|
4588
|
+
* The source configuration details for the web data source.
|
4589
|
+
*/
|
4590
|
+
sourceConfiguration: WebSourceConfiguration;
|
4591
|
+
}
|
4592
|
+
export type WebScopeType = "HOST_ONLY"|"SUBDOMAINS"|string;
|
4593
|
+
export interface WebSourceConfiguration {
|
4594
|
+
/**
|
4595
|
+
* The configuration of the URL/URLs.
|
4596
|
+
*/
|
4597
|
+
urlConfiguration: UrlConfiguration;
|
4598
|
+
}
|
2598
4599
|
/**
|
2599
4600
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
2600
4601
|
*/
|