@aws-sdk/client-bedrock-agent 3.1140.0 → 3.1141.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 +28 -0
- package/dist-cjs/index.js +157 -8
- package/dist-es/BedrockAgent.js +10 -0
- package/dist-es/commands/CreateVpcConfigurationCommand.js +4 -0
- package/dist-es/commands/DeleteVpcConfigurationCommand.js +4 -0
- package/dist-es/commands/GetVpcConfigurationCommand.js +4 -0
- package/dist-es/commands/ListVpcConfigurationsCommand.js +4 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +15 -0
- package/dist-es/pagination/ListVpcConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +101 -7
- package/dist-types/BedrockAgent.d.ts +35 -0
- package/dist-types/BedrockAgentClient.d.ts +6 -2
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/CreateVpcConfigurationCommand.d.ts +106 -0
- package/dist-types/commands/DeleteVpcConfigurationCommand.d.ts +91 -0
- package/dist-types/commands/GetVpcConfigurationCommand.d.ts +105 -0
- package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListVpcConfigurationsCommand.d.ts +106 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +39 -0
- package/dist-types/models/models_0.d.ts +217 -114
- package/dist-types/models/models_1.d.ts +227 -3
- package/dist-types/pagination/ListVpcConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +75 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateVpcConfigurationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteVpcConfigurationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetVpcConfigurationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBaseDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVpcConfigurationsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +19 -0
- package/dist-types/ts3.4/models/models_0.d.ts +53 -29
- package/dist-types/ts3.4/models/models_1.d.ts +58 -2
- package/dist-types/ts3.4/pagination/ListVpcConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/core/serde";
|
|
2
2
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import type { AccessControlAccess, AccessControlPrincipalType, ActionGroupSignature, ActionGroupState, AgentAliasStatus, AgentCollaboration, AgentStatus, AliasInvocationState, CachePointType, ChunkingStrategy, ConcurrencyType, ConfluenceAuthType, ConfluenceHostType, ContentDataSourceType, ContextEnrichmentType, ConversationRole, CrawlFilterConfigurationType, CreationMode, CustomControlMethod, CustomSourceType, DataDeletionPolicy, DataSourceStatus, DataSourceType, DayOfWeek, DocumentStatus, EnabledOrDisabledState, EnrichmentStrategyMethod, FlowConnectionType, FlowNodeInputCategory, FlowNodeIODataType, FlowStatus, FlowValidationSeverity, FlowValidationType, IncludedData, IncompatibleLoopNodeType, IngestionJobFilterAttribute, IngestionJobFilterOperator, IngestionJobSortByAttribute, IngestionJobStatus, InlineContentType, KnowledgeBaseState, MemoryType, MetadataSourceType, MetadataValueType, OrchestrationType, ParsingModality, ParsingStrategy, PerformanceConfigLatency, PromptState, PromptTemplateType, PromptType, RelayConversationHistory, RequireConfirmation, RerankingMetadataSelectionMode, SalesforceAuthType, SharePointAuthType, SharePointHostType, SortOrder, StepType, SupportedLanguages, Type, VectorSearchRerankingConfigurationType, WebScopeType } from "./enums";
|
|
3
|
+
import type { AccessControlAccess, AccessControlPrincipalType, ActionGroupSignature, ActionGroupState, AgentAliasStatus, AgentCollaboration, AgentStatus, AliasInvocationState, CachePointType, ChunkingStrategy, ConcurrencyType, ConfluenceAuthType, ConfluenceHostType, ContentDataSourceType, ContextEnrichmentType, ConversationRole, CrawlFilterConfigurationType, CreationMode, CustomControlMethod, CustomSourceType, DataDeletionPolicy, DataSourceStatus, DataSourceType, DayOfWeek, DocumentStatus, EnabledOrDisabledState, EnrichmentStrategyMethod, FlowConnectionType, FlowNodeInputCategory, FlowNodeIODataType, FlowStatus, FlowValidationSeverity, FlowValidationType, IncludedData, IncompatibleLoopNodeType, IngestionJobFilterAttribute, IngestionJobFilterOperator, IngestionJobSortByAttribute, IngestionJobStatus, InlineContentType, KnowledgeBaseState, MemoryType, MetadataSourceType, MetadataValueType, OrchestrationType, ParsingModality, ParsingStrategy, PerformanceConfigLatency, PromptState, PromptTemplateType, PromptType, RelayConversationHistory, RequireConfirmation, RerankingMetadataSelectionMode, SalesforceAuthType, SharePointAuthType, SharePointHostType, SortOrder, StepType, SupportedLanguages, Type, VectorSearchRerankingConfigurationType, VpcConfigurationStatus, VpcProtocol, VpcResolutionMode, WebScopeType } from "./enums";
|
|
4
4
|
/**
|
|
5
5
|
* <p>Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.</p>
|
|
6
6
|
* @public
|
|
@@ -2059,6 +2059,86 @@ export interface UpdateAgentAliasResponse {
|
|
|
2059
2059
|
*/
|
|
2060
2060
|
agentAlias: AgentAlias | undefined;
|
|
2061
2061
|
}
|
|
2062
|
+
/**
|
|
2063
|
+
* @public
|
|
2064
|
+
*/
|
|
2065
|
+
export interface CreateVpcConfigurationRequest {
|
|
2066
|
+
/**
|
|
2067
|
+
* <p>The unique identifier of the knowledge base to associate this VPC configuration with.</p>
|
|
2068
|
+
* @public
|
|
2069
|
+
*/
|
|
2070
|
+
knowledgeBaseId: string | undefined;
|
|
2071
|
+
/**
|
|
2072
|
+
* <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.</p>
|
|
2073
|
+
* @public
|
|
2074
|
+
*/
|
|
2075
|
+
clientToken?: string | undefined;
|
|
2076
|
+
/**
|
|
2077
|
+
* <p>The identifier of the VPC that the knowledge base connects through to reach the resource.</p>
|
|
2078
|
+
* @public
|
|
2079
|
+
*/
|
|
2080
|
+
vpcId: string | undefined;
|
|
2081
|
+
/**
|
|
2082
|
+
* <p>The subnets, in the VPC identified by <code>vpcId</code>, that the knowledge base uses to connect to the resource.</p>
|
|
2083
|
+
* @public
|
|
2084
|
+
*/
|
|
2085
|
+
subnetIds: string[] | undefined;
|
|
2086
|
+
/**
|
|
2087
|
+
* <p>The private IPv4 address or DNS name of the resource you want the knowledge base to reach. The target must be privately reachable from inside your VPC, such as an internal load balancer or a private IP. The following are not supported:</p> <ul> <li> <p>Internet-facing endpoints</p> </li> <li> <p>Loopback addresses</p> </li> <li> <p>Link-local addresses</p> </li> <li> <p>Wildcard addresses</p> </li> <li> <p>Multicast addresses</p> </li> <li> <p>IPv6 literals</p> </li> </ul>
|
|
2088
|
+
* @public
|
|
2089
|
+
*/
|
|
2090
|
+
resourceTarget: string | undefined;
|
|
2091
|
+
/**
|
|
2092
|
+
* <p>The port on which to reach the resource.</p>
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
2095
|
+
port: number | undefined;
|
|
2096
|
+
/**
|
|
2097
|
+
* <p>The protocol used to connect to the resource. Specify <code>HTTP</code> for plaintext or <code>HTTPS</code> for TLS. When you specify <code>HTTPS</code>, you must also provide <code>tlsServerName</code>.</p>
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
2100
|
+
protocol: VpcProtocol | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>Controls how a domain-name <code>resourceTarget</code> is resolved. This applies only when the target is a domain name; it has no effect for IP-address targets, which have no name to resolve. In all cases the resolved address must be reachable from inside your VPC. Valid values:</p> <ul> <li> <p> <code>IN_VPC</code> (default, recommended) – The target domain name is resolved privately, using the DNS resolvers of the VPC, such as private Route 53 hosted zones or on-premises DNS reachable from the VPC. Use this for targets that are private to your VPC, such as internal load balancers, private hosted-zone names, or on-premises hosts.</p> </li> <li> <p> <code>PUBLIC</code> – The target domain name is resolved against public DNS resolvers. Select this only when the target's domain name must be resolved through public DNS and the resulting address is still reachable from the VPC, an uncommon split-horizon configuration. If you are unsure, use <code>IN_VPC</code>.</p> </li> </ul>
|
|
2103
|
+
* @public
|
|
2104
|
+
*/
|
|
2105
|
+
resolutionMode: VpcResolutionMode | undefined;
|
|
2106
|
+
/**
|
|
2107
|
+
* <p>An optional HTTP <code>Host</code> header value to send when invoking the resource. Set this only if your resource (or an upstream router or ingress) routes by the <code>Host</code> header and that host differs from the target. This setting is independent of <code>tlsServerName</code>.</p>
|
|
2108
|
+
* @public
|
|
2109
|
+
*/
|
|
2110
|
+
hostHeader?: string | undefined;
|
|
2111
|
+
/**
|
|
2112
|
+
* <p>The expected TLS server name. The service matches this value against the Subject Alternative Names on your resource's TLS certificate during invocation. This field is required when <code>protocol</code> is <code>HTTPS</code>. Set it to a hostname on your certificate, such as <code>app.internal.example.com</code>. You can use a single leftmost wildcard, such as <code>*.example.com</code>. The value must be a hostname without a port.</p>
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
2115
|
+
tlsServerName?: string | undefined;
|
|
2116
|
+
/**
|
|
2117
|
+
* <p>An optional human-readable name for the VPC configuration. If you don't specify a name, the VPC configuration has no name.</p>
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
name?: string | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* <p>An optional description of the VPC configuration. If you don't specify a description, the VPC configuration has no description.</p>
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
2125
|
+
description?: string | undefined;
|
|
2126
|
+
}
|
|
2127
|
+
/**
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
export interface CreateVpcConfigurationResponse {
|
|
2131
|
+
/**
|
|
2132
|
+
* <p>The unique identifier of the VPC configuration that was created.</p>
|
|
2133
|
+
* @public
|
|
2134
|
+
*/
|
|
2135
|
+
vpcConfigurationId: string | undefined;
|
|
2136
|
+
/**
|
|
2137
|
+
* <p>The current status of the VPC configuration. Immediately after creation this is <code>CREATING</code>.</p>
|
|
2138
|
+
* @public
|
|
2139
|
+
*/
|
|
2140
|
+
status: VpcConfigurationStatus | undefined;
|
|
2141
|
+
}
|
|
2062
2142
|
/**
|
|
2063
2143
|
* <p>The specific filters applied to your data source content. You can filter out or include certain content.</p>
|
|
2064
2144
|
* @public
|
|
@@ -3315,6 +3395,36 @@ export interface DeleteResourcePolicyResponse {
|
|
|
3315
3395
|
*/
|
|
3316
3396
|
revisionId?: string | undefined;
|
|
3317
3397
|
}
|
|
3398
|
+
/**
|
|
3399
|
+
* @public
|
|
3400
|
+
*/
|
|
3401
|
+
export interface DeleteVpcConfigurationRequest {
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>The unique identifier of the knowledge base that owns the VPC configuration.</p>
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3406
|
+
knowledgeBaseId: string | undefined;
|
|
3407
|
+
/**
|
|
3408
|
+
* <p>The unique identifier of the VPC configuration to delete.</p>
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
3411
|
+
vpcConfigurationId: string | undefined;
|
|
3412
|
+
}
|
|
3413
|
+
/**
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
3416
|
+
export interface DeleteVpcConfigurationResponse {
|
|
3417
|
+
/**
|
|
3418
|
+
* <p>The unique identifier of the VPC configuration being deleted.</p>
|
|
3419
|
+
* @public
|
|
3420
|
+
*/
|
|
3421
|
+
vpcConfigurationId: string | undefined;
|
|
3422
|
+
/**
|
|
3423
|
+
* <p>The current status of the VPC configuration. Immediately after a delete request this is <code>DELETING</code>.</p>
|
|
3424
|
+
* @public
|
|
3425
|
+
*/
|
|
3426
|
+
status: VpcConfigurationStatus | undefined;
|
|
3427
|
+
}
|
|
3318
3428
|
/**
|
|
3319
3429
|
* <p>The configuration of a connection between a condition node and another node.</p>
|
|
3320
3430
|
* @public
|
|
@@ -7067,6 +7177,112 @@ export interface GetResourcePolicyResponse {
|
|
|
7067
7177
|
*/
|
|
7068
7178
|
revisionId: string | undefined;
|
|
7069
7179
|
}
|
|
7180
|
+
/**
|
|
7181
|
+
* @public
|
|
7182
|
+
*/
|
|
7183
|
+
export interface GetVpcConfigurationRequest {
|
|
7184
|
+
/**
|
|
7185
|
+
* <p>The unique identifier of the knowledge base that owns the VPC configuration.</p>
|
|
7186
|
+
* @public
|
|
7187
|
+
*/
|
|
7188
|
+
knowledgeBaseId: string | undefined;
|
|
7189
|
+
/**
|
|
7190
|
+
* <p>The unique identifier of the VPC configuration to retrieve.</p>
|
|
7191
|
+
* @public
|
|
7192
|
+
*/
|
|
7193
|
+
vpcConfigurationId: string | undefined;
|
|
7194
|
+
}
|
|
7195
|
+
/**
|
|
7196
|
+
* <p>Contains the details of a VPC configuration, including its connection settings, resolution mode, and current lifecycle status.</p>
|
|
7197
|
+
* @public
|
|
7198
|
+
*/
|
|
7199
|
+
export interface VpcConfiguration {
|
|
7200
|
+
/**
|
|
7201
|
+
* <p>The unique identifier of the VPC configuration.</p>
|
|
7202
|
+
* @public
|
|
7203
|
+
*/
|
|
7204
|
+
vpcConfigurationId: string | undefined;
|
|
7205
|
+
/**
|
|
7206
|
+
* <p>The current lifecycle status of the VPC configuration.</p>
|
|
7207
|
+
* @public
|
|
7208
|
+
*/
|
|
7209
|
+
status: VpcConfigurationStatus | undefined;
|
|
7210
|
+
/**
|
|
7211
|
+
* <p>Additional detail about the current status, such as the cause of a <code>CREATE_FAILED</code> or <code>DELETE_FAILED</code> status.</p>
|
|
7212
|
+
* @public
|
|
7213
|
+
*/
|
|
7214
|
+
statusMessage?: string | undefined;
|
|
7215
|
+
/**
|
|
7216
|
+
* <p>The identifier of the VPC that the knowledge base connects through to reach the resource.</p>
|
|
7217
|
+
* @public
|
|
7218
|
+
*/
|
|
7219
|
+
vpcId: string | undefined;
|
|
7220
|
+
/**
|
|
7221
|
+
* <p>The subnets that the knowledge base uses to connect to the resource.</p>
|
|
7222
|
+
* @public
|
|
7223
|
+
*/
|
|
7224
|
+
subnetIds: string[] | undefined;
|
|
7225
|
+
/**
|
|
7226
|
+
* <p>The private IPv4 address or DNS name of the resource.</p>
|
|
7227
|
+
* @public
|
|
7228
|
+
*/
|
|
7229
|
+
resourceTarget: string | undefined;
|
|
7230
|
+
/**
|
|
7231
|
+
* <p>The port on which the resource is reached.</p>
|
|
7232
|
+
* @public
|
|
7233
|
+
*/
|
|
7234
|
+
port: number | undefined;
|
|
7235
|
+
/**
|
|
7236
|
+
* <p>The protocol used to connect to the resource.</p>
|
|
7237
|
+
* @public
|
|
7238
|
+
*/
|
|
7239
|
+
protocol: VpcProtocol | undefined;
|
|
7240
|
+
/**
|
|
7241
|
+
* <p>Specifies how the resource target is resolved.</p>
|
|
7242
|
+
* @public
|
|
7243
|
+
*/
|
|
7244
|
+
resolutionMode: VpcResolutionMode | undefined;
|
|
7245
|
+
/**
|
|
7246
|
+
* <p>The HTTP <code>Host</code> header value sent when invoking the resource, if configured.</p>
|
|
7247
|
+
* @public
|
|
7248
|
+
*/
|
|
7249
|
+
hostHeader?: string | undefined;
|
|
7250
|
+
/**
|
|
7251
|
+
* <p>The expected TLS server name that the service matches against the Subject Alternative Names on the resource's TLS certificate. Present when <code>protocol</code> is <code>HTTPS</code>.</p>
|
|
7252
|
+
* @public
|
|
7253
|
+
*/
|
|
7254
|
+
tlsServerName?: string | undefined;
|
|
7255
|
+
/**
|
|
7256
|
+
* <p>The human-readable name of the VPC configuration, if provided.</p>
|
|
7257
|
+
* @public
|
|
7258
|
+
*/
|
|
7259
|
+
name?: string | undefined;
|
|
7260
|
+
/**
|
|
7261
|
+
* <p>The description of the VPC configuration, if provided.</p>
|
|
7262
|
+
* @public
|
|
7263
|
+
*/
|
|
7264
|
+
description?: string | undefined;
|
|
7265
|
+
/**
|
|
7266
|
+
* <p>The time at which the VPC configuration was created.</p>
|
|
7267
|
+
* @public
|
|
7268
|
+
*/
|
|
7269
|
+
createdAt: Date | undefined;
|
|
7270
|
+
/**
|
|
7271
|
+
* <p>The time at which the VPC configuration was last updated.</p>
|
|
7272
|
+
* @public
|
|
7273
|
+
*/
|
|
7274
|
+
updatedAt: Date | undefined;
|
|
7275
|
+
}
|
|
7276
|
+
/**
|
|
7277
|
+
* @public
|
|
7278
|
+
*/
|
|
7279
|
+
export interface GetVpcConfigurationResponse {
|
|
7280
|
+
/**
|
|
7281
|
+
* <p>The VPC configuration, including its connection settings, resolution mode, and current lifecycle status.</p>
|
|
7282
|
+
* @public
|
|
7283
|
+
*/
|
|
7284
|
+
vpcConfiguration: VpcConfiguration | undefined;
|
|
7285
|
+
}
|
|
7070
7286
|
/**
|
|
7071
7287
|
* @public
|
|
7072
7288
|
*/
|
|
@@ -7792,116 +8008,3 @@ export interface IngestKnowledgeBaseDocumentsResponse {
|
|
|
7792
8008
|
*/
|
|
7793
8009
|
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7794
8010
|
}
|
|
7795
|
-
/**
|
|
7796
|
-
* @public
|
|
7797
|
-
*/
|
|
7798
|
-
export interface ListKnowledgeBaseDocumentsRequest {
|
|
7799
|
-
/**
|
|
7800
|
-
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7801
|
-
* @public
|
|
7802
|
-
*/
|
|
7803
|
-
knowledgeBaseId: string | undefined;
|
|
7804
|
-
/**
|
|
7805
|
-
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7806
|
-
* @public
|
|
7807
|
-
*/
|
|
7808
|
-
dataSourceId: string | undefined;
|
|
7809
|
-
/**
|
|
7810
|
-
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7811
|
-
* @public
|
|
7812
|
-
*/
|
|
7813
|
-
maxResults?: number | undefined;
|
|
7814
|
-
/**
|
|
7815
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
7816
|
-
* @public
|
|
7817
|
-
*/
|
|
7818
|
-
nextToken?: string | undefined;
|
|
7819
|
-
}
|
|
7820
|
-
/**
|
|
7821
|
-
* @public
|
|
7822
|
-
*/
|
|
7823
|
-
export interface ListKnowledgeBaseDocumentsResponse {
|
|
7824
|
-
/**
|
|
7825
|
-
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
7826
|
-
* @public
|
|
7827
|
-
*/
|
|
7828
|
-
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7829
|
-
/**
|
|
7830
|
-
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7831
|
-
* @public
|
|
7832
|
-
*/
|
|
7833
|
-
nextToken?: string | undefined;
|
|
7834
|
-
}
|
|
7835
|
-
/**
|
|
7836
|
-
* @public
|
|
7837
|
-
*/
|
|
7838
|
-
export interface AssociateAgentKnowledgeBaseRequest {
|
|
7839
|
-
/**
|
|
7840
|
-
* <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
|
|
7841
|
-
* @public
|
|
7842
|
-
*/
|
|
7843
|
-
agentId: string | undefined;
|
|
7844
|
-
/**
|
|
7845
|
-
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
7846
|
-
* @public
|
|
7847
|
-
*/
|
|
7848
|
-
agentVersion: string | undefined;
|
|
7849
|
-
/**
|
|
7850
|
-
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
7851
|
-
* @public
|
|
7852
|
-
*/
|
|
7853
|
-
knowledgeBaseId: string | undefined;
|
|
7854
|
-
/**
|
|
7855
|
-
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
7856
|
-
* @public
|
|
7857
|
-
*/
|
|
7858
|
-
description: string | undefined;
|
|
7859
|
-
/**
|
|
7860
|
-
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
7861
|
-
* @public
|
|
7862
|
-
*/
|
|
7863
|
-
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
7864
|
-
}
|
|
7865
|
-
/**
|
|
7866
|
-
* @public
|
|
7867
|
-
*/
|
|
7868
|
-
export interface AssociateAgentKnowledgeBaseResponse {
|
|
7869
|
-
/**
|
|
7870
|
-
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
7871
|
-
* @public
|
|
7872
|
-
*/
|
|
7873
|
-
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
7874
|
-
}
|
|
7875
|
-
/**
|
|
7876
|
-
* <p>Settings for an Amazon Kendra knowledge base.</p>
|
|
7877
|
-
* @public
|
|
7878
|
-
*/
|
|
7879
|
-
export interface KendraKnowledgeBaseConfiguration {
|
|
7880
|
-
/**
|
|
7881
|
-
* <p>The ARN of the Amazon Kendra index.</p>
|
|
7882
|
-
* @public
|
|
7883
|
-
*/
|
|
7884
|
-
kendraIndexArn: string | undefined;
|
|
7885
|
-
}
|
|
7886
|
-
/**
|
|
7887
|
-
* <p>Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.</p>
|
|
7888
|
-
* @public
|
|
7889
|
-
*/
|
|
7890
|
-
export interface AudioSegmentationConfiguration {
|
|
7891
|
-
/**
|
|
7892
|
-
* <p>The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.</p>
|
|
7893
|
-
* @public
|
|
7894
|
-
*/
|
|
7895
|
-
fixedLengthDuration: number | undefined;
|
|
7896
|
-
}
|
|
7897
|
-
/**
|
|
7898
|
-
* <p>Configuration settings for processing audio content in multimodal knowledge bases.</p>
|
|
7899
|
-
* @public
|
|
7900
|
-
*/
|
|
7901
|
-
export interface AudioConfiguration {
|
|
7902
|
-
/**
|
|
7903
|
-
* <p>Configuration for segmenting audio content during processing.</p>
|
|
7904
|
-
* @public
|
|
7905
|
-
*/
|
|
7906
|
-
segmentationConfiguration: AudioSegmentationConfiguration | undefined;
|
|
7907
|
-
}
|
|
@@ -1,7 +1,120 @@
|
|
|
1
1
|
import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/core/serde";
|
|
2
2
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import type { AgentStatus, EmbeddingDataType, EmbeddingModelType, FlowNodeType, FlowStatus, IncludedData, IncludeExclude, KnowledgeBaseState, KnowledgeBaseStatus, KnowledgeBaseStorageType, KnowledgeBaseType, PromptTemplateType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, SupplementalDataStorageLocationType } from "./enums";
|
|
4
|
-
import type { AgentFlowNodeConfiguration, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentVersion, AgentVersionSummary,
|
|
3
|
+
import type { AgentStatus, EmbeddingDataType, EmbeddingModelType, FlowNodeType, FlowStatus, IncludedData, IncludeExclude, KnowledgeBaseState, KnowledgeBaseStatus, KnowledgeBaseStorageType, KnowledgeBaseType, PromptTemplateType, QueryEngineType, RedshiftProvisionedAuthType, RedshiftQueryEngineStorageType, RedshiftQueryEngineType, RedshiftServerlessAuthType, SupplementalDataStorageLocationType, VpcConfigurationStatus, VpcProtocol, VpcResolutionMode } from "./enums";
|
|
4
|
+
import type { AgentFlowNodeConfiguration, AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentVersion, AgentVersionSummary, CollectorFlowNodeConfiguration, ConditionFlowNodeConfiguration, FlowConnection, FlowNodeInput, FlowNodeOutput, FlowValidation, InlineCodeFlowNodeConfiguration, InputFlowNodeConfiguration, IteratorFlowNodeConfiguration, KnowledgeBaseDocumentDetail, KnowledgeBaseFlowNodeConfiguration, LambdaFunctionFlowNodeConfiguration, LexFlowNodeConfiguration, LoopControllerFlowNodeConfiguration, LoopInputFlowNodeConfiguration, OutputFlowNodeConfiguration, PromptFlowNodeConfiguration, PromptInferenceConfiguration, PromptTemplateConfiguration, RetrievalFlowNodeConfiguration, S3Location, ServerSideEncryptionConfiguration, StorageFlowNodeConfiguration } from "./models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ListKnowledgeBaseDocumentsRequest {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
knowledgeBaseId: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
dataSourceId: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
maxResults?: number | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
nextToken?: string | undefined;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface ListKnowledgeBaseDocumentsResponse {
|
|
34
|
+
/**
|
|
35
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
nextToken?: string | undefined;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface AssociateAgentKnowledgeBaseRequest {
|
|
49
|
+
/**
|
|
50
|
+
* <p>The unique identifier of the agent with which you want to associate the knowledge base.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
agentId: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
agentVersion: string | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
knowledgeBaseId: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
description: string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export interface AssociateAgentKnowledgeBaseResponse {
|
|
79
|
+
/**
|
|
80
|
+
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* <p>Settings for an Amazon Kendra knowledge base.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export interface KendraKnowledgeBaseConfiguration {
|
|
90
|
+
/**
|
|
91
|
+
* <p>The ARN of the Amazon Kendra index.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
kendraIndexArn: string | undefined;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* <p>Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export interface AudioSegmentationConfiguration {
|
|
101
|
+
/**
|
|
102
|
+
* <p>The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
fixedLengthDuration: number | undefined;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* <p>Configuration settings for processing audio content in multimodal knowledge bases.</p>
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export interface AudioConfiguration {
|
|
112
|
+
/**
|
|
113
|
+
* <p>Configuration for segmenting audio content during processing.</p>
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
segmentationConfiguration: AudioSegmentationConfiguration | undefined;
|
|
117
|
+
}
|
|
5
118
|
/**
|
|
6
119
|
* <p>Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.</p>
|
|
7
120
|
* @public
|
|
@@ -54,7 +167,7 @@ export interface BedrockEmbeddingModelConfiguration {
|
|
|
54
167
|
*/
|
|
55
168
|
video?: VideoConfiguration[] | undefined;
|
|
56
169
|
/**
|
|
57
|
-
* <p>Model-specific configuration for the embedding model, provided as a JSON object. Use this field to specify settings that apply to the embedding model that you selected, such as how audio and video files are divided into segments.</p> <p>The fields that this object accepts depend on the embedding model. For the settings that each model accepts, see the documentation for that model.</p>
|
|
170
|
+
* <p>Model-specific configuration for the embedding model, provided as a JSON object. Use this field to specify settings that apply to the embedding model that you selected, such as how audio and video files are divided into segments.</p> <p>The fields that this object accepts depend on the embedding model. For the settings that each model accepts, see the documentation for that model.</p> <p>For an example of a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html">CreateKnowledgeBase</a> request that uses this field to configure a multimodal embedding model, see the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html#API_agent_CreateKnowledgeBase_Examples">Examples</a> section of <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html">CreateKnowledgeBase</a>.</p>
|
|
58
171
|
* @public
|
|
59
172
|
*/
|
|
60
173
|
modelConfiguration?: __DocumentType | undefined;
|
|
@@ -1253,6 +1366,117 @@ export interface UpdateKnowledgeBaseResponse {
|
|
|
1253
1366
|
*/
|
|
1254
1367
|
knowledgeBase: KnowledgeBase | undefined;
|
|
1255
1368
|
}
|
|
1369
|
+
/**
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1372
|
+
export interface ListVpcConfigurationsRequest {
|
|
1373
|
+
/**
|
|
1374
|
+
* <p>The unique identifier of the knowledge base whose VPC configurations you want to list.</p>
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
knowledgeBaseId: string | undefined;
|
|
1378
|
+
/**
|
|
1379
|
+
* <p>The status to filter the results by. Only VPC configurations with the specified status are returned.</p>
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
statusFilter?: VpcConfigurationStatus | undefined;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>The maximum number of results to return in the response. If more results are available, the response returns a <code>nextToken</code>.</p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
maxResults?: number | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>A pagination token to retrieve the next page of results, returned in a previous response when more results are available.</p>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
nextToken?: string | undefined;
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* <p>A summary of a VPC configuration returned by <code>ListVpcConfigurations</code>.</p>
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
export interface VpcConfigurationSummary {
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The unique identifier of the VPC configuration.</p>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
vpcConfigurationId: string | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>The current lifecycle status of the VPC configuration.</p>
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
status: VpcConfigurationStatus | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* <p>Additional detail about the current status, such as the cause of a failure.</p>
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
statusMessage?: string | undefined;
|
|
1414
|
+
/**
|
|
1415
|
+
* <p>The identifier of the VPC that the knowledge base connects through to reach the resource.</p>
|
|
1416
|
+
* @public
|
|
1417
|
+
*/
|
|
1418
|
+
vpcId: string | undefined;
|
|
1419
|
+
/**
|
|
1420
|
+
* <p>The private IPv4 address or DNS name of the resource.</p>
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
resourceTarget: string | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* <p>The port on which the resource is reached.</p>
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
port: number | undefined;
|
|
1429
|
+
/**
|
|
1430
|
+
* <p>The protocol used to connect to the resource.</p>
|
|
1431
|
+
* @public
|
|
1432
|
+
*/
|
|
1433
|
+
protocol: VpcProtocol | undefined;
|
|
1434
|
+
/**
|
|
1435
|
+
* <p>Specifies how the resource target is resolved.</p>
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
resolutionMode: VpcResolutionMode | undefined;
|
|
1439
|
+
/**
|
|
1440
|
+
* <p>The HTTP <code>Host</code> header value sent when invoking the resource, if configured.</p>
|
|
1441
|
+
* @public
|
|
1442
|
+
*/
|
|
1443
|
+
hostHeader?: string | undefined;
|
|
1444
|
+
/**
|
|
1445
|
+
* <p>The expected TLS server name that the service matches against the Subject Alternative Names on the resource's TLS certificate. Present when <code>protocol</code> is <code>HTTPS</code>.</p>
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
tlsServerName?: string | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>The human-readable name of the VPC configuration, if provided.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
name?: string | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>The description of the VPC configuration, if provided.</p>
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
description?: string | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>The time at which the VPC configuration was created.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
createdAt: Date | undefined;
|
|
1464
|
+
}
|
|
1465
|
+
/**
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
export interface ListVpcConfigurationsResponse {
|
|
1469
|
+
/**
|
|
1470
|
+
* <p>A list of VPC configuration summaries.</p>
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
items: VpcConfigurationSummary[] | undefined;
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>A pagination token to retrieve the next page of results, present when the total number of results exceeds the maximum number of results.</p>
|
|
1476
|
+
* @public
|
|
1477
|
+
*/
|
|
1478
|
+
nextToken?: string | undefined;
|
|
1479
|
+
}
|
|
1256
1480
|
/**
|
|
1257
1481
|
* <p>Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html">Automate tasks in your application using conversational agents</a>.</p>
|
|
1258
1482
|
* @public
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListVpcConfigurationsCommandInput, ListVpcConfigurationsCommandOutput } from "../commands/ListVpcConfigurationsCommand";
|
|
3
|
+
import type { BedrockAgentPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListVpcConfigurations: (config: BedrockAgentPaginationConfiguration, input: ListVpcConfigurationsCommandInput, ...rest: any[]) => Paginator<ListVpcConfigurationsCommandOutput>;
|