Agents for Amazon Bedrock 2023-06-05
- Client: Aws\BedrockAgent\BedrockAgentClient
- Service ID: bedrock-agent
- Version: 2023-06-05
This page describes the parameters and results for the operations of the Agents for Amazon Bedrock (2023-06-05), and shows how to use the Aws\BedrockAgent\BedrockAgentClient object to call the described operations. This documentation is specific to the 2023-06-05 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateAgentKnowledgeBase ( array $params = [] )
- Associates a knowledge base with an agent.
- CreateAgent ( array $params = [] )
- Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
- CreateAgentActionGroup ( array $params = [] )
- Creates an action group for an agent.
- CreateAgentAlias ( array $params = [] )
- Creates an alias of an agent that can be used to deploy the agent.
- CreateDataSource ( array $params = [] )
- Sets up a data source to be added to a knowledge base.
- CreateKnowledgeBase ( array $params = [] )
- Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
- DeleteAgent ( array $params = [] )
- Deletes an agent.
- DeleteAgentActionGroup ( array $params = [] )
- Deletes an action group in an agent.
- DeleteAgentAlias ( array $params = [] )
- Deletes an alias of an agent.
- DeleteAgentVersion ( array $params = [] )
- Deletes a version of an agent.
- DeleteDataSource ( array $params = [] )
- Deletes a data source from a knowledge base.
- DeleteKnowledgeBase ( array $params = [] )
- Deletes a knowledge base.
- DisassociateAgentKnowledgeBase ( array $params = [] )
- Disassociates a knowledge base from an agent.
- GetAgent ( array $params = [] )
- Gets information about an agent.
- GetAgentActionGroup ( array $params = [] )
- Gets information about an action group for an agent.
- GetAgentAlias ( array $params = [] )
- Gets information about an alias of an agent.
- GetAgentKnowledgeBase ( array $params = [] )
- Gets information about a knowledge base associated with an agent.
- GetAgentVersion ( array $params = [] )
- Gets details about a version of an agent.
- GetDataSource ( array $params = [] )
- Gets information about a data source.
- GetIngestionJob ( array $params = [] )
- Gets information about a ingestion job, in which a data source is added to a knowledge base.
- GetKnowledgeBase ( array $params = [] )
- Gets information about a knoweldge base.
- ListAgentActionGroups ( array $params = [] )
- Lists the action groups for an agent and information about each one.
- ListAgentAliases ( array $params = [] )
- Lists the aliases of an agent and information about each one.
- ListAgentKnowledgeBases ( array $params = [] )
- Lists knowledge bases associated with an agent and information about each one.
- ListAgentVersions ( array $params = [] )
- Lists the versions of an agent and information about each version.
- ListAgents ( array $params = [] )
- Lists the agents belonging to an account and information about each agent.
- ListDataSources ( array $params = [] )
- Lists the data sources in a knowledge base and information about each one.
- ListIngestionJobs ( array $params = [] )
- Lists the ingestion jobs for a data source and information about each of them.
- ListKnowledgeBases ( array $params = [] )
- Lists the knowledge bases in an account and information about each of them.
- ListTagsForResource ( array $params = [] )
- List all the tags for the resource you specify.
- PrepareAgent ( array $params = [] )
- Creates a DRAFT version of the agent that can be used for internal testing.
- StartIngestionJob ( array $params = [] )
- Begins an ingestion job, in which a data source is added to a knowledge base.
- TagResource ( array $params = [] )
- Associate tags with a resource.
- UntagResource ( array $params = [] )
- Remove tags from a resource.
- UpdateAgent ( array $params = [] )
- Updates the configuration of an agent.
- UpdateAgentActionGroup ( array $params = [] )
- Updates the configuration for an action group for an agent.
- UpdateAgentAlias ( array $params = [] )
- Updates configurations for an alias of an agent.
- UpdateAgentKnowledgeBase ( array $params = [] )
- Updates the configuration for a knowledge base that has been associated with an agent.
- UpdateDataSource ( array $params = [] )
- Updates configurations for a data source.
- UpdateKnowledgeBase ( array $params = [] )
- Updates the configuration of a knowledge base with the fields that you specify.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAgentActionGroups
- ListAgentAliases
- ListAgentKnowledgeBases
- ListAgentVersions
- ListAgents
- ListDataSources
- ListIngestionJobs
- ListKnowledgeBases
Operations
AssociateAgentKnowledgeBase
$result = $client->associateAgentKnowledgeBase
([/* ... */]); $promise = $client->associateAgentKnowledgeBaseAsync
([/* ... */]);
Associates a knowledge base with an agent. If a knowledge base is associated and its indexState
is set to Enabled
, the agent queries the knowledge base for information to augment its response to the user.
Parameter Syntax
$result = $client->associateAgentKnowledgeBase([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'description' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED 'knowledgeBaseState' => 'ENABLED|DISABLED', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent with which you want to associate the knowledge base.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent with which you want to associate the knowledge base.
- description
-
- Required: Yes
- Type: string
A description of what the agent should use the knowledge base for.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to associate with the agent.
- knowledgeBaseState
-
- Type: string
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
Result Syntax
[ 'agentKnowledgeBase' => [ 'agentId' => '<string>', 'agentVersion' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'knowledgeBaseState' => 'ENABLED|DISABLED', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentKnowledgeBase
-
- Required: Yes
- Type: AgentKnowledgeBase structure
Contains details about the knowledge base that has been associated with the agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
CreateAgent
$result = $client->createAgent
([/* ... */]); $promise = $client->createAgentAsync
([/* ... */]);
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 subsequentInvokeAgent
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 ofrecommendedActions
for you to troubleshoot.
Parameter Syntax
$result = $client->createAgent([ 'agentName' => '<string>', // REQUIRED 'agentResourceRoleArn' => '<string>', 'clientToken' => '<string>', 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'foundationModel' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ // REQUIRED [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- agentName
-
- Required: Yes
- Type: string
A name for the agent that you create.
- agentResourceRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
- clientToken
-
- Type: string
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.
- customerEncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
- description
-
- Type: string
A description of the agent.
- foundationModel
-
- Type: string
The foundation model to be used for orchestration by the agent you create.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The unique Guardrail configuration assigned to the agent when it is created.
- idleSessionTTLInSeconds
-
- Type: int
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
- instruction
-
- Type: string
Instructions that tell the agent what it should do and how it should interact with users.
- promptOverrideConfiguration
-
- Type: PromptOverrideConfiguration structure
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Any tags that you want to attach to the agent.
Result Syntax
[ 'agent' => [ 'agentArn' => '<string>', 'agentId' => '<string>', 'agentName' => '<string>', 'agentResourceRoleArn' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'foundationModel' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'preparedAt' => <DateTime>, 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], 'recommendedActions' => ['<string>', ...], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agent
-
- Required: Yes
- Type: Agent structure
Contains details about the agent created.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
CreateAgentActionGroup
$result = $client->createAgentActionGroup
([/* ... */]); $promise = $client->createAgentActionGroupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createAgentActionGroup([ 'actionGroupExecutor' => [ 'customControl' => 'RETURN_CONTROL', 'lambda' => '<string>', ], 'actionGroupName' => '<string>', // REQUIRED 'actionGroupState' => 'ENABLED|DISABLED', 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 's3BucketName' => '<string>', 's3ObjectKey' => '<string>', ], ], 'clientToken' => '<string>', 'description' => '<string>', 'functionSchema' => [ 'functions' => [ [ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'parameters' => [ '<Name>' => [ 'description' => '<string>', 'required' => true || false, 'type' => 'string|number|integer|boolean|array', // REQUIRED ], // ... ], ], // ... ], ], 'parentActionGroupSignature' => 'AMAZON.UserInput', ]);
Parameter Details
Members
- actionGroupExecutor
-
- Type: ActionGroupExecutor structure
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.
- actionGroupName
-
- Required: Yes
- Type: string
The name to give the action group.
- actionGroupState
-
- Type: string
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent for which to create the action group.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent for which to create the action group.
- apiSchema
-
- Type: APISchema structure
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
- clientToken
-
- Type: string
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.
- description
-
- Type: string
A description of the action group.
- functionSchema
-
- Type: FunctionSchema structure
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parentActionGroupSignature
-
- Type: string
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 thedescription
,apiSchema
, andactionGroupExecutor
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.
Result Syntax
[ 'agentActionGroup' => [ 'actionGroupExecutor' => [ 'customControl' => 'RETURN_CONTROL', 'lambda' => '<string>', ], 'actionGroupId' => '<string>', 'actionGroupName' => '<string>', 'actionGroupState' => 'ENABLED|DISABLED', 'agentId' => '<string>', 'agentVersion' => '<string>', 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 's3BucketName' => '<string>', 's3ObjectKey' => '<string>', ], ], 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'functionSchema' => [ 'functions' => [ [ 'description' => '<string>', 'name' => '<string>', 'parameters' => [ '<Name>' => [ 'description' => '<string>', 'required' => true || false, 'type' => 'string|number|integer|boolean|array', ], // ... ], ], // ... ], ], 'parentActionSignature' => 'AMAZON.UserInput', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentActionGroup
-
- Required: Yes
- Type: AgentActionGroup structure
Contains details about the action group that was created.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
CreateAgentAlias
$result = $client->createAgentAlias
([/* ... */]); $promise = $client->createAgentAliasAsync
([/* ... */]);
Creates an alias of an agent that can be used to deploy the agent.
Parameter Syntax
$result = $client->createAgentAlias([ 'agentAliasName' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'description' => '<string>', 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- agentAliasName
-
- Required: Yes
- Type: string
The name of the alias.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- clientToken
-
- Type: string
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.
- description
-
- Type: string
A description of the alias of the agent.
- routingConfiguration
-
- Type: Array of AgentAliasRoutingConfigurationListItem structures
Contains details about the routing configuration of the alias.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Any tags that you want to attach to the alias of the agent.
Result Syntax
[ 'agentAlias' => [ 'agentAliasArn' => '<string>', 'agentAliasHistoryEvents' => [ [ 'endDate' => <DateTime>, 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'startDate' => <DateTime>, ], // ... ], 'agentAliasId' => '<string>', 'agentAliasName' => '<string>', 'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING', 'agentId' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentAlias
-
- Required: Yes
- Type: AgentAlias structure
Contains details about the alias that was created.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
CreateDataSource
$result = $client->createDataSource
([/* ... */]); $promise = $client->createDataSourceAsync
([/* ... */]);
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
Parameter Syntax
$result = $client->createDataSource([ 'clientToken' => '<string>', 'dataDeletionPolicy' => 'RETAIN|DELETE', 'dataSourceConfiguration' => [ // REQUIRED 's3Configuration' => [ 'bucketArn' => '<string>', // REQUIRED 'bucketOwnerAccountId' => '<string>', 'inclusionPrefixes' => ['<string>', ...], ], 'type' => 'S3', // REQUIRED ], 'description' => '<string>', 'knowledgeBaseId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'serverSideEncryptionConfiguration' => [ 'kmsKeyArn' => '<string>', ], 'vectorIngestionConfiguration' => [ 'chunkingConfiguration' => [ 'chunkingStrategy' => 'FIXED_SIZE|NONE', // REQUIRED 'fixedSizeChunkingConfiguration' => [ 'maxTokens' => <integer>, // REQUIRED 'overlapPercentage' => <integer>, // REQUIRED ], ], ], ]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- dataDeletionPolicy
-
- Type: string
The data deletion policy assigned to the data source.
- dataSourceConfiguration
-
- Required: Yes
- Type: DataSourceConfiguration structure
Contains metadata about where the data source is stored.
- description
-
- Type: string
A description of the data source.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which to add the data source.
- name
-
- Required: Yes
- Type: string
The name of the data source.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
Contains details about the server-side encryption for the data source.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in the data source.
Result Syntax
[ 'dataSource' => [ 'createdAt' => <DateTime>, 'dataDeletionPolicy' => 'RETAIN|DELETE', 'dataSourceConfiguration' => [ 's3Configuration' => [ 'bucketArn' => '<string>', 'bucketOwnerAccountId' => '<string>', 'inclusionPrefixes' => ['<string>', ...], ], 'type' => 'S3', ], 'dataSourceId' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'serverSideEncryptionConfiguration' => [ 'kmsKeyArn' => '<string>', ], 'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL', 'updatedAt' => <DateTime>, 'vectorIngestionConfiguration' => [ 'chunkingConfiguration' => [ 'chunkingStrategy' => 'FIXED_SIZE|NONE', 'fixedSizeChunkingConfiguration' => [ 'maxTokens' => <integer>, 'overlapPercentage' => <integer>, ], ], ], ], ]
Result Details
Members
- dataSource
-
- Required: Yes
- Type: DataSource structure
Contains details about the data source.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
CreateKnowledgeBase
$result = $client->createKnowledgeBase
([/* ... */]); $promise = $client->createKnowledgeBaseAsync
([/* ... */]);
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 optionaldescription
. -
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 theknowledgeBaseConfiguration
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.
-
Parameter Syntax
$result = $client->createKnowledgeBase([ 'clientToken' => '<string>', 'description' => '<string>', 'knowledgeBaseConfiguration' => [ // REQUIRED 'type' => 'VECTOR', // REQUIRED 'vectorKnowledgeBaseConfiguration' => [ 'embeddingModelArn' => '<string>', // REQUIRED 'embeddingModelConfiguration' => [ 'bedrockEmbeddingModelConfiguration' => [ 'dimensions' => <integer>, ], ], ], ], 'name' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED 'storageConfiguration' => [ // REQUIRED 'mongoDbAtlasConfiguration' => [ 'collectionName' => '<string>', // REQUIRED 'credentialsSecretArn' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED 'endpointServiceName' => '<string>', 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'opensearchServerlessConfiguration' => [ 'collectionArn' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'pineconeConfiguration' => [ 'connectionString' => '<string>', // REQUIRED 'credentialsSecretArn' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED ], 'namespace' => '<string>', ], 'rdsConfiguration' => [ 'credentialsSecretArn' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'primaryKeyField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'resourceArn' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ], 'redisEnterpriseCloudConfiguration' => [ 'credentialsSecretArn' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', // REQUIRED ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- description
-
- Type: string
A description of the knowledge base.
- knowledgeBaseConfiguration
-
- Required: Yes
- Type: KnowledgeBaseConfiguration structure
Contains details about the embeddings model used for the knowledge base.
- name
-
- Required: Yes
- Type: string
A name for the knowledge base.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- storageConfiguration
-
- Required: Yes
- Type: StorageConfiguration structure
Contains details about the configuration of the vector database used for the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
Result Syntax
[ 'knowledgeBase' => [ 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseArn' => '<string>', 'knowledgeBaseConfiguration' => [ 'type' => 'VECTOR', 'vectorKnowledgeBaseConfiguration' => [ 'embeddingModelArn' => '<string>', 'embeddingModelConfiguration' => [ 'bedrockEmbeddingModelConfiguration' => [ 'dimensions' => <integer>, ], ], ], ], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'roleArn' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL', 'storageConfiguration' => [ 'mongoDbAtlasConfiguration' => [ 'collectionName' => '<string>', 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'endpoint' => '<string>', 'endpointServiceName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'opensearchServerlessConfiguration' => [ 'collectionArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'pineconeConfiguration' => [ 'connectionString' => '<string>', 'credentialsSecretArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', ], 'namespace' => '<string>', ], 'rdsConfiguration' => [ 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'primaryKeyField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'resourceArn' => '<string>', 'tableName' => '<string>', ], 'redisEnterpriseCloudConfiguration' => [ 'credentialsSecretArn' => '<string>', 'endpoint' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- knowledgeBase
-
- Required: Yes
- Type: KnowledgeBase structure
Contains details about the knowledge base.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
DeleteAgent
$result = $client->deleteAgent
([/* ... */]); $promise = $client->deleteAgentAsync
([/* ... */]);
Deletes an agent.
Parameter Syntax
$result = $client->deleteAgent([ 'agentId' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent to delete.
- skipResourceInUseCheck
-
- Type: boolean
By default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
Result Syntax
[ 'agentId' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', ]
Result Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that was deleted.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
DeleteAgentActionGroup
$result = $client->deleteAgentActionGroup
([/* ... */]); $promise = $client->deleteAgentActionGroupAsync
([/* ... */]);
Deletes an action group in an agent.
Parameter Syntax
$result = $client->deleteAgentActionGroup([ 'actionGroupId' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- actionGroupId
-
- Required: Yes
- Type: string
The unique identifier of the action group to delete.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the action group belongs to.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent that the action group belongs to.
- skipResourceInUseCheck
-
- Type: boolean
By default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
DeleteAgentAlias
$result = $client->deleteAgentAlias
([/* ... */]); $promise = $client->deleteAgentAliasAsync
([/* ... */]);
Deletes an alias of an agent.
Parameter Syntax
$result = $client->deleteAgentAlias([ 'agentAliasId' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentAliasId
-
- Required: Yes
- Type: string
The unique identifier of the alias to delete.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the alias belongs to.
Result Syntax
[ 'agentAliasId' => '<string>', 'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING', 'agentId' => '<string>', ]
Result Details
Members
- agentAliasId
-
- Required: Yes
- Type: string
The unique identifier of the alias that was deleted.
- agentAliasStatus
-
- Required: Yes
- Type: string
The status of the alias.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the alias belongs to.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
DeleteAgentVersion
$result = $client->deleteAgentVersion
([/* ... */]); $promise = $client->deleteAgentVersionAsync
([/* ... */]);
Deletes a version of an agent.
Parameter Syntax
$result = $client->deleteAgentVersion([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the version belongs to.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent to delete.
- skipResourceInUseCheck
-
- Type: boolean
By default, this value is
false
and deletion is stopped if the resource is in use. If you set it totrue
, the resource will be deleted even if the resource is in use.
Result Syntax
[ 'agentId' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', ]
Result Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the version belongs to.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent version.
- agentVersion
-
- Required: Yes
- Type: string
The version that was deleted.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
DeleteDataSource
$result = $client->deleteDataSource
([/* ... */]); $promise = $client->deleteDataSourceAsync
([/* ... */]);
Deletes a data source from a knowledge base.
Parameter Syntax
$result = $client->deleteDataSource([ 'dataSourceId' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source to delete.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base from which to delete the data source.
Result Syntax
[ 'dataSourceId' => '<string>', 'knowledgeBaseId' => '<string>', 'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL', ]
Result Details
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source that was deleted.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source that was deleted belonged.
- status
-
- Required: Yes
- Type: string
The status of the data source.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
DeleteKnowledgeBase
$result = $client->deleteKnowledgeBase
([/* ... */]); $promise = $client->deleteKnowledgeBaseAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteKnowledgeBase([ 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to delete.
Result Syntax
[ 'knowledgeBaseId' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL', ]
Result Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base that was deleted.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base and whether it has been successfully deleted.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
DisassociateAgentKnowledgeBase
$result = $client->disassociateAgentKnowledgeBase
([/* ... */]); $promise = $client->disassociateAgentKnowledgeBaseAsync
([/* ... */]);
Disassociates a knowledge base from an agent.
Parameter Syntax
$result = $client->disassociateAgentKnowledgeBase([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent from which to disassociate the knowledge base.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent from which to disassociate the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to disassociate.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
GetAgent
$result = $client->getAgent
([/* ... */]); $promise = $client->getAgentAsync
([/* ... */]);
Gets information about an agent.
Parameter Syntax
$result = $client->getAgent([ 'agentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
Result Syntax
[ 'agent' => [ 'agentArn' => '<string>', 'agentId' => '<string>', 'agentName' => '<string>', 'agentResourceRoleArn' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'foundationModel' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'preparedAt' => <DateTime>, 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], 'recommendedActions' => ['<string>', ...], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agent
-
- Required: Yes
- Type: Agent structure
Contains details about the agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetAgentActionGroup
$result = $client->getAgentActionGroup
([/* ... */]); $promise = $client->getAgentActionGroupAsync
([/* ... */]);
Gets information about an action group for an agent.
Parameter Syntax
$result = $client->getAgentActionGroup([ 'actionGroupId' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- actionGroupId
-
- Required: Yes
- Type: string
The unique identifier of the action group for which to get information.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the action group belongs to.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent that the action group belongs to.
Result Syntax
[ 'agentActionGroup' => [ 'actionGroupExecutor' => [ 'customControl' => 'RETURN_CONTROL', 'lambda' => '<string>', ], 'actionGroupId' => '<string>', 'actionGroupName' => '<string>', 'actionGroupState' => 'ENABLED|DISABLED', 'agentId' => '<string>', 'agentVersion' => '<string>', 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 's3BucketName' => '<string>', 's3ObjectKey' => '<string>', ], ], 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'functionSchema' => [ 'functions' => [ [ 'description' => '<string>', 'name' => '<string>', 'parameters' => [ '<Name>' => [ 'description' => '<string>', 'required' => true || false, 'type' => 'string|number|integer|boolean|array', ], // ... ], ], // ... ], ], 'parentActionSignature' => 'AMAZON.UserInput', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentActionGroup
-
- Required: Yes
- Type: AgentActionGroup structure
Contains details about the action group.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetAgentAlias
$result = $client->getAgentAlias
([/* ... */]); $promise = $client->getAgentAliasAsync
([/* ... */]);
Gets information about an alias of an agent.
Parameter Syntax
$result = $client->getAgentAlias([ 'agentAliasId' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentAliasId
-
- Required: Yes
- Type: string
The unique identifier of the alias for which to get information.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent to which the alias to get information belongs.
Result Syntax
[ 'agentAlias' => [ 'agentAliasArn' => '<string>', 'agentAliasHistoryEvents' => [ [ 'endDate' => <DateTime>, 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'startDate' => <DateTime>, ], // ... ], 'agentAliasId' => '<string>', 'agentAliasName' => '<string>', 'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING', 'agentId' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentAlias
-
- Required: Yes
- Type: AgentAlias structure
Contains information about the alias.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetAgentKnowledgeBase
$result = $client->getAgentKnowledgeBase
([/* ... */]); $promise = $client->getAgentKnowledgeBaseAsync
([/* ... */]);
Gets information about a knowledge base associated with an agent.
Parameter Syntax
$result = $client->getAgentKnowledgeBase([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent with which the knowledge base is associated.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent with which the knowledge base is associated.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base associated with the agent.
Result Syntax
[ 'agentKnowledgeBase' => [ 'agentId' => '<string>', 'agentVersion' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'knowledgeBaseState' => 'ENABLED|DISABLED', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentKnowledgeBase
-
- Required: Yes
- Type: AgentKnowledgeBase structure
Contains details about a knowledge base attached to an agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetAgentVersion
$result = $client->getAgentVersion
([/* ... */]); $promise = $client->getAgentVersionAsync
([/* ... */]);
Gets details about a version of an agent.
Parameter Syntax
$result = $client->getAgentVersion([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent.
Result Syntax
[ 'agentVersion' => [ 'agentArn' => '<string>', 'agentId' => '<string>', 'agentName' => '<string>', 'agentResourceRoleArn' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'createdAt' => <DateTime>, 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'foundationModel' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], 'recommendedActions' => ['<string>', ...], 'updatedAt' => <DateTime>, 'version' => '<string>', ], ]
Result Details
Members
- agentVersion
-
- Required: Yes
- Type: AgentVersion structure
Contains details about the version of the agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetDataSource
$result = $client->getDataSource
([/* ... */]); $promise = $client->getDataSourceAsync
([/* ... */]);
Gets information about a data source.
Parameter Syntax
$result = $client->getDataSource([ 'dataSourceId' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base that the data source was added to.
Result Syntax
[ 'dataSource' => [ 'createdAt' => <DateTime>, 'dataDeletionPolicy' => 'RETAIN|DELETE', 'dataSourceConfiguration' => [ 's3Configuration' => [ 'bucketArn' => '<string>', 'bucketOwnerAccountId' => '<string>', 'inclusionPrefixes' => ['<string>', ...], ], 'type' => 'S3', ], 'dataSourceId' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'serverSideEncryptionConfiguration' => [ 'kmsKeyArn' => '<string>', ], 'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL', 'updatedAt' => <DateTime>, 'vectorIngestionConfiguration' => [ 'chunkingConfiguration' => [ 'chunkingStrategy' => 'FIXED_SIZE|NONE', 'fixedSizeChunkingConfiguration' => [ 'maxTokens' => <integer>, 'overlapPercentage' => <integer>, ], ], ], ], ]
Result Details
Members
- dataSource
-
- Required: Yes
- Type: DataSource structure
Contains details about the data source.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetIngestionJob
$result = $client->getIngestionJob
([/* ... */]); $promise = $client->getIngestionJobAsync
([/* ... */]);
Gets information about a ingestion job, in which a data source is added to a knowledge base.
Parameter Syntax
$result = $client->getIngestionJob([ 'dataSourceId' => '<string>', // REQUIRED 'ingestionJobId' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source in the ingestion job.
- ingestionJobId
-
- Required: Yes
- Type: string
The unique identifier of the ingestion job.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base for which the ingestion job applies.
Result Syntax
[ 'ingestionJob' => [ 'dataSourceId' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'ingestionJobId' => '<string>', 'knowledgeBaseId' => '<string>', 'startedAt' => <DateTime>, 'statistics' => [ 'numberOfDocumentsDeleted' => <integer>, 'numberOfDocumentsFailed' => <integer>, 'numberOfDocumentsScanned' => <integer>, 'numberOfMetadataDocumentsModified' => <integer>, 'numberOfMetadataDocumentsScanned' => <integer>, 'numberOfModifiedDocumentsIndexed' => <integer>, 'numberOfNewDocumentsIndexed' => <integer>, ], 'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- ingestionJob
-
- Required: Yes
- Type: IngestionJob structure
Contains details about the ingestion job.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
GetKnowledgeBase
$result = $client->getKnowledgeBase
([/* ... */]); $promise = $client->getKnowledgeBaseAsync
([/* ... */]);
Gets information about a knoweldge base.
Parameter Syntax
$result = $client->getKnowledgeBase([ 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base for which to get information.
Result Syntax
[ 'knowledgeBase' => [ 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseArn' => '<string>', 'knowledgeBaseConfiguration' => [ 'type' => 'VECTOR', 'vectorKnowledgeBaseConfiguration' => [ 'embeddingModelArn' => '<string>', 'embeddingModelConfiguration' => [ 'bedrockEmbeddingModelConfiguration' => [ 'dimensions' => <integer>, ], ], ], ], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'roleArn' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL', 'storageConfiguration' => [ 'mongoDbAtlasConfiguration' => [ 'collectionName' => '<string>', 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'endpoint' => '<string>', 'endpointServiceName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'opensearchServerlessConfiguration' => [ 'collectionArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'pineconeConfiguration' => [ 'connectionString' => '<string>', 'credentialsSecretArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', ], 'namespace' => '<string>', ], 'rdsConfiguration' => [ 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'primaryKeyField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'resourceArn' => '<string>', 'tableName' => '<string>', ], 'redisEnterpriseCloudConfiguration' => [ 'credentialsSecretArn' => '<string>', 'endpoint' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- knowledgeBase
-
- Required: Yes
- Type: KnowledgeBase structure
Contains details about the knowledge base.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListAgentActionGroups
$result = $client->listAgentActionGroups
([/* ... */]); $promise = $client->listAgentActionGroupsAsync
([/* ... */]);
Lists the action groups for an agent and information about each one.
Parameter Syntax
$result = $client->listAgentActionGroups([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'actionGroupSummaries' => [ [ 'actionGroupId' => '<string>', 'actionGroupName' => '<string>', 'actionGroupState' => 'ENABLED|DISABLED', 'description' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- actionGroupSummaries
-
- Required: Yes
- Type: Array of ActionGroupSummary structures
A list of objects, each of which contains information about an action group.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListAgentAliases
$result = $client->listAgentAliases
([/* ... */]); $promise = $client->listAgentAliasesAsync
([/* ... */]);
Lists the aliases of an agent and information about each one.
Parameter Syntax
$result = $client->listAgentAliases([ 'agentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'agentAliasSummaries' => [ [ 'agentAliasId' => '<string>', 'agentAliasName' => '<string>', 'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING', 'createdAt' => <DateTime>, 'description' => '<string>', 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- agentAliasSummaries
-
- Required: Yes
- Type: Array of AgentAliasSummary structures
A list of objects, each of which contains information about an alias of the agent.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListAgentKnowledgeBases
$result = $client->listAgentKnowledgeBases
([/* ... */]); $promise = $client->listAgentKnowledgeBasesAsync
([/* ... */]);
Lists knowledge bases associated with an agent and information about each one.
Parameter Syntax
$result = $client->listAgentKnowledgeBases([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent for which to return information about knowledge bases associated with it.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent for which to return information about knowledge bases associated with it.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'agentKnowledgeBaseSummaries' => [ [ 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'knowledgeBaseState' => 'ENABLED|DISABLED', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- agentKnowledgeBaseSummaries
-
- Required: Yes
- Type: Array of AgentKnowledgeBaseSummary structures
A list of objects, each of which contains information about a knowledge base associated with the agent.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListAgentVersions
$result = $client->listAgentVersions
([/* ... */]); $promise = $client->listAgentVersionsAsync
([/* ... */]);
Lists the versions of an agent and information about each version.
Parameter Syntax
$result = $client->listAgentVersions([ 'agentId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'agentVersionSummaries' => [ [ 'agentName' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- agentVersionSummaries
-
- Required: Yes
- Type: Array of AgentVersionSummary structures
A list of objects, each of which contains information about a version of the agent.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListAgents
$result = $client->listAgents
([/* ... */]); $promise = $client->listAgentsAsync
([/* ... */]);
Lists the agents belonging to an account and information about each agent.
Parameter Syntax
$result = $client->listAgents([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'agentSummaries' => [ [ 'agentId' => '<string>', 'agentName' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'description' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'latestAgentVersion' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- agentSummaries
-
- Required: Yes
- Type: Array of AgentSummary structures
A list of objects, each of which contains information about an agent.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
ListDataSources
$result = $client->listDataSources
([/* ... */]); $promise = $client->listDataSourcesAsync
([/* ... */]);
Lists the data sources in a knowledge base and information about each one.
Parameter Syntax
$result = $client->listDataSources([ 'knowledgeBaseId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base for which to return a list of information.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'dataSourceSummaries' => [ [ 'dataSourceId' => '<string>', 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- dataSourceSummaries
-
- Required: Yes
- Type: Array of DataSourceSummary structures
A list of objects, each of which contains information about a data source.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListIngestionJobs
$result = $client->listIngestionJobs
([/* ... */]); $promise = $client->listIngestionJobsAsync
([/* ... */]);
Lists the ingestion jobs for a data source and information about each of them.
Parameter Syntax
$result = $client->listIngestionJobs([ 'dataSourceId' => '<string>', // REQUIRED 'filters' => [ [ 'attribute' => 'STATUS', // REQUIRED 'operator' => 'EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'knowledgeBaseId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'STATUS|STARTED_AT', // REQUIRED 'order' => 'ASCENDING|DESCENDING', // REQUIRED ], ]);
Parameter Details
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source for which to return ingestion jobs.
- filters
-
- Type: Array of IngestionJobFilter structures
Contains a definition of a filter for which to filter the results.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base for which to return ingestion jobs.
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results. - sortBy
-
- Type: IngestionJobSortBy structure
Contains details about how to sort the results.
Result Syntax
[ 'ingestionJobSummaries' => [ [ 'dataSourceId' => '<string>', 'description' => '<string>', 'ingestionJobId' => '<string>', 'knowledgeBaseId' => '<string>', 'startedAt' => <DateTime>, 'statistics' => [ 'numberOfDocumentsDeleted' => <integer>, 'numberOfDocumentsFailed' => <integer>, 'numberOfDocumentsScanned' => <integer>, 'numberOfMetadataDocumentsModified' => <integer>, 'numberOfMetadataDocumentsScanned' => <integer>, 'numberOfModifiedDocumentsIndexed' => <integer>, 'numberOfNewDocumentsIndexed' => <integer>, ], 'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- ingestionJobSummaries
-
- Required: Yes
- Type: Array of IngestionJobSummary structures
A list of objects, each of which contains information about an ingestion job.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ListKnowledgeBases
$result = $client->listKnowledgeBases
([/* ... */]); $promise = $client->listKnowledgeBasesAsync
([/* ... */]);
Lists the knowledge bases in an account and information about each of them.
Parameter Syntax
$result = $client->listKnowledgeBases([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
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. - nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Result Syntax
[ 'knowledgeBaseSummaries' => [ [ 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL', 'updatedAt' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- knowledgeBaseSummaries
-
- Required: Yes
- Type: Array of KnowledgeBaseSummary structures
A list of objects, each of which contains information about a knowledge base.
- nextToken
-
- Type: string
If the total number of results is greater than the
maxResults
value provided in the request, use this token when making another request in thenextToken
field to return the next batch of results.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
List all the tags for the resource you specify.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource for which to list tags.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The key-value pairs for the tags associated with the resource.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
PrepareAgent
$result = $client->prepareAgent
([/* ... */]); $promise = $client->prepareAgentAsync
([/* ... */]);
Creates a DRAFT
version of the agent that can be used for internal testing.
Parameter Syntax
$result = $client->prepareAgent([ 'agentId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent for which to create a
DRAFT
version.
Result Syntax
[ 'agentId' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', 'preparedAt' => <DateTime>, ]
Result Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent for which the
DRAFT
version was created. - agentStatus
-
- Required: Yes
- Type: string
The status of the
DRAFT
version and whether it is ready for use. - agentVersion
-
- Required: Yes
- Type: string
The version of the agent.
- preparedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the
DRAFT
version of the agent was last prepared.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
StartIngestionJob
$result = $client->startIngestionJob
([/* ... */]); $promise = $client->startIngestionJobAsync
([/* ... */]);
Begins an ingestion job, in which a data source is added to a knowledge base.
Parameter Syntax
$result = $client->startIngestionJob([ 'clientToken' => '<string>', 'dataSourceId' => '<string>', // REQUIRED 'description' => '<string>', 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
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.
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source to ingest.
- description
-
- Type: string
A description of the ingestion job.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which to add the data source.
Result Syntax
[ 'ingestionJob' => [ 'dataSourceId' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'ingestionJobId' => '<string>', 'knowledgeBaseId' => '<string>', 'startedAt' => <DateTime>, 'statistics' => [ 'numberOfDocumentsDeleted' => <integer>, 'numberOfDocumentsFailed' => <integer>, 'numberOfDocumentsScanned' => <integer>, 'numberOfMetadataDocumentsModified' => <integer>, 'numberOfMetadataDocumentsScanned' => <integer>, 'numberOfModifiedDocumentsIndexed' => <integer>, 'numberOfNewDocumentsIndexed' => <integer>, ], 'status' => 'STARTING|IN_PROGRESS|COMPLETE|FAILED', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- ingestionJob
-
- Required: Yes
- Type: IngestionJob structure
An object containing information about the ingestion job.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to tag.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
An object containing key-value pairs that define the tags to attach to the resource.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Remove tags from a resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource from which to remove tags.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of keys of the tags to remove from the resource.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
UpdateAgent
$result = $client->updateAgent
([/* ... */]); $promise = $client->updateAgentAsync
([/* ... */]);
Updates the configuration of an agent.
Parameter Syntax
$result = $client->updateAgent([ 'agentId' => '<string>', // REQUIRED 'agentName' => '<string>', // REQUIRED 'agentResourceRoleArn' => '<string>', // REQUIRED 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'foundationModel' => '<string>', // REQUIRED 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ // REQUIRED [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- agentName
-
- Required: Yes
- Type: string
Specifies a new name for the agent.
- agentResourceRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
- customerEncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
- description
-
- Type: string
Specifies a new description of the agent.
- foundationModel
-
- Required: Yes
- Type: string
Specifies a new foundation model to be used for orchestration by the agent.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The unique Guardrail configuration assigned to the agent when it is updated.
- idleSessionTTLInSeconds
-
- Type: int
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
- instruction
-
- Type: string
Specifies new instructions that tell the agent what it should do and how it should interact with users.
- promptOverrideConfiguration
-
- Type: PromptOverrideConfiguration structure
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Result Syntax
[ 'agent' => [ 'agentArn' => '<string>', 'agentId' => '<string>', 'agentName' => '<string>', 'agentResourceRoleArn' => '<string>', 'agentStatus' => 'CREATING|PREPARING|PREPARED|NOT_PREPARED|DELETING|FAILED|VERSIONING|UPDATING', 'agentVersion' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'customerEncryptionKeyArn' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'foundationModel' => '<string>', 'guardrailConfiguration' => [ 'guardrailIdentifier' => '<string>', 'guardrailVersion' => '<string>', ], 'idleSessionTTLInSeconds' => <integer>, 'instruction' => '<string>', 'preparedAt' => <DateTime>, 'promptOverrideConfiguration' => [ 'overrideLambda' => '<string>', 'promptConfigurations' => [ [ 'basePromptTemplate' => '<string>', 'inferenceConfiguration' => [ 'maximumLength' => <integer>, 'stopSequences' => ['<string>', ...], 'temperature' => <float>, 'topK' => <integer>, 'topP' => <float>, ], 'parserMode' => 'DEFAULT|OVERRIDDEN', 'promptCreationMode' => 'DEFAULT|OVERRIDDEN', 'promptState' => 'ENABLED|DISABLED', 'promptType' => 'PRE_PROCESSING|ORCHESTRATION|POST_PROCESSING|KNOWLEDGE_BASE_RESPONSE_GENERATION', ], // ... ], ], 'recommendedActions' => ['<string>', ...], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agent
-
- Required: Yes
- Type: Agent structure
Contains details about the agent that was updated.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
UpdateAgentActionGroup
$result = $client->updateAgentActionGroup
([/* ... */]); $promise = $client->updateAgentActionGroupAsync
([/* ... */]);
Updates the configuration for an action group for an agent.
Parameter Syntax
$result = $client->updateAgentActionGroup([ 'actionGroupExecutor' => [ 'customControl' => 'RETURN_CONTROL', 'lambda' => '<string>', ], 'actionGroupId' => '<string>', // REQUIRED 'actionGroupName' => '<string>', // REQUIRED 'actionGroupState' => 'ENABLED|DISABLED', 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 's3BucketName' => '<string>', 's3ObjectKey' => '<string>', ], ], 'description' => '<string>', 'functionSchema' => [ 'functions' => [ [ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'parameters' => [ '<Name>' => [ 'description' => '<string>', 'required' => true || false, 'type' => 'string|number|integer|boolean|array', // REQUIRED ], // ... ], ], // ... ], ], 'parentActionGroupSignature' => 'AMAZON.UserInput', ]);
Parameter Details
Members
- actionGroupExecutor
-
- Type: ActionGroupExecutor structure
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
- actionGroupId
-
- Required: Yes
- Type: string
The unique identifier of the action group.
- actionGroupName
-
- Required: Yes
- Type: string
Specifies a new name for the action group.
- actionGroupState
-
- Type: string
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent for which to update the action group.
- agentVersion
-
- Required: Yes
- Type: string
The unique identifier of the agent version for which to update the action group.
- apiSchema
-
- Type: APISchema structure
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
- description
-
- Type: string
Specifies a new name for the action group.
- functionSchema
-
- Type: FunctionSchema structure
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
- parentActionGroupSignature
-
- Type: string
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 thedescription
,apiSchema
, andactionGroupExecutor
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.
Result Syntax
[ 'agentActionGroup' => [ 'actionGroupExecutor' => [ 'customControl' => 'RETURN_CONTROL', 'lambda' => '<string>', ], 'actionGroupId' => '<string>', 'actionGroupName' => '<string>', 'actionGroupState' => 'ENABLED|DISABLED', 'agentId' => '<string>', 'agentVersion' => '<string>', 'apiSchema' => [ 'payload' => '<string>', 's3' => [ 's3BucketName' => '<string>', 's3ObjectKey' => '<string>', ], ], 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'functionSchema' => [ 'functions' => [ [ 'description' => '<string>', 'name' => '<string>', 'parameters' => [ '<Name>' => [ 'description' => '<string>', 'required' => true || false, 'type' => 'string|number|integer|boolean|array', ], // ... ], ], // ... ], ], 'parentActionSignature' => 'AMAZON.UserInput', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentActionGroup
-
- Required: Yes
- Type: AgentActionGroup structure
Contains details about the action group that was updated.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
UpdateAgentAlias
$result = $client->updateAgentAlias
([/* ... */]); $promise = $client->updateAgentAliasAsync
([/* ... */]);
Updates configurations for an alias of an agent.
Parameter Syntax
$result = $client->updateAgentAlias([ 'agentAliasId' => '<string>', // REQUIRED 'agentAliasName' => '<string>', // REQUIRED 'agentId' => '<string>', // REQUIRED 'description' => '<string>', 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], ]);
Parameter Details
Members
- agentAliasId
-
- Required: Yes
- Type: string
The unique identifier of the alias.
- agentAliasName
-
- Required: Yes
- Type: string
Specifies a new name for the alias.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- description
-
- Type: string
Specifies a new description for the alias.
- routingConfiguration
-
- Type: Array of AgentAliasRoutingConfigurationListItem structures
Contains details about the routing configuration of the alias.
Result Syntax
[ 'agentAlias' => [ 'agentAliasArn' => '<string>', 'agentAliasHistoryEvents' => [ [ 'endDate' => <DateTime>, 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'startDate' => <DateTime>, ], // ... ], 'agentAliasId' => '<string>', 'agentAliasName' => '<string>', 'agentAliasStatus' => 'CREATING|PREPARED|FAILED|UPDATING|DELETING', 'agentId' => '<string>', 'clientToken' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'routingConfiguration' => [ [ 'agentVersion' => '<string>', 'provisionedThroughput' => '<string>', ], // ... ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentAlias
-
- Required: Yes
- Type: AgentAlias structure
Contains details about the alias that was updated.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
- ServiceQuotaExceededException:
The number of requests exceeds the service quota. Resubmit your request later.
UpdateAgentKnowledgeBase
$result = $client->updateAgentKnowledgeBase
([/* ... */]); $promise = $client->updateAgentKnowledgeBaseAsync
([/* ... */]);
Updates the configuration for a knowledge base that has been associated with an agent.
Parameter Syntax
$result = $client->updateAgentKnowledgeBase([ 'agentId' => '<string>', // REQUIRED 'agentVersion' => '<string>', // REQUIRED 'description' => '<string>', 'knowledgeBaseId' => '<string>', // REQUIRED 'knowledgeBaseState' => 'ENABLED|DISABLED', ]);
Parameter Details
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent associated with the knowledge base that you want to update.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent associated with the knowledge base that you want to update.
- description
-
- Type: string
Specifies a new description for the knowledge base associated with an agent.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base that has been associated with an agent.
- knowledgeBaseState
-
- Type: string
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
Result Syntax
[ 'agentKnowledgeBase' => [ 'agentId' => '<string>', 'agentVersion' => '<string>', 'createdAt' => <DateTime>, 'description' => '<string>', 'knowledgeBaseId' => '<string>', 'knowledgeBaseState' => 'ENABLED|DISABLED', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- agentKnowledgeBase
-
- Required: Yes
- Type: AgentKnowledgeBase structure
Contains details about the knowledge base that has been associated with an agent.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
UpdateDataSource
$result = $client->updateDataSource
([/* ... */]); $promise = $client->updateDataSourceAsync
([/* ... */]);
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing chunkingConfiguration
.
Parameter Syntax
$result = $client->updateDataSource([ 'dataDeletionPolicy' => 'RETAIN|DELETE', 'dataSourceConfiguration' => [ // REQUIRED 's3Configuration' => [ 'bucketArn' => '<string>', // REQUIRED 'bucketOwnerAccountId' => '<string>', 'inclusionPrefixes' => ['<string>', ...], ], 'type' => 'S3', // REQUIRED ], 'dataSourceId' => '<string>', // REQUIRED 'description' => '<string>', 'knowledgeBaseId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'serverSideEncryptionConfiguration' => [ 'kmsKeyArn' => '<string>', ], 'vectorIngestionConfiguration' => [ 'chunkingConfiguration' => [ 'chunkingStrategy' => 'FIXED_SIZE|NONE', // REQUIRED 'fixedSizeChunkingConfiguration' => [ 'maxTokens' => <integer>, // REQUIRED 'overlapPercentage' => <integer>, // REQUIRED ], ], ], ]);
Parameter Details
Members
- dataDeletionPolicy
-
- Type: string
The data deletion policy of the updated data source.
- dataSourceConfiguration
-
- Required: Yes
- Type: DataSourceConfiguration structure
Contains details about the storage configuration of the data source.
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source.
- description
-
- Type: string
Specifies a new description for the data source.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source belongs.
- name
-
- Required: Yes
- Type: string
Specifies a new name for the data source.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
Contains details about server-side encryption of the data source.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in the data source.
Result Syntax
[ 'dataSource' => [ 'createdAt' => <DateTime>, 'dataDeletionPolicy' => 'RETAIN|DELETE', 'dataSourceConfiguration' => [ 's3Configuration' => [ 'bucketArn' => '<string>', 'bucketOwnerAccountId' => '<string>', 'inclusionPrefixes' => ['<string>', ...], ], 'type' => 'S3', ], 'dataSourceId' => '<string>', 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'serverSideEncryptionConfiguration' => [ 'kmsKeyArn' => '<string>', ], 'status' => 'AVAILABLE|DELETING|DELETE_UNSUCCESSFUL', 'updatedAt' => <DateTime>, 'vectorIngestionConfiguration' => [ 'chunkingConfiguration' => [ 'chunkingStrategy' => 'FIXED_SIZE|NONE', 'fixedSizeChunkingConfiguration' => [ 'maxTokens' => <integer>, 'overlapPercentage' => <integer>, ], ], ], ], ]
Result Details
Members
- dataSource
-
- Required: Yes
- Type: DataSource structure
Contains details about the data source.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
UpdateKnowledgeBase
$result = $client->updateKnowledgeBase
([/* ... */]); $promise = $client->updateKnowledgeBaseAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateKnowledgeBase([ 'description' => '<string>', 'knowledgeBaseConfiguration' => [ // REQUIRED 'type' => 'VECTOR', // REQUIRED 'vectorKnowledgeBaseConfiguration' => [ 'embeddingModelArn' => '<string>', // REQUIRED 'embeddingModelConfiguration' => [ 'bedrockEmbeddingModelConfiguration' => [ 'dimensions' => <integer>, ], ], ], ], 'knowledgeBaseId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED 'storageConfiguration' => [ // REQUIRED 'mongoDbAtlasConfiguration' => [ 'collectionName' => '<string>', // REQUIRED 'credentialsSecretArn' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED 'endpointServiceName' => '<string>', 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'opensearchServerlessConfiguration' => [ 'collectionArn' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'pineconeConfiguration' => [ 'connectionString' => '<string>', // REQUIRED 'credentialsSecretArn' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED ], 'namespace' => '<string>', ], 'rdsConfiguration' => [ 'credentialsSecretArn' => '<string>', // REQUIRED 'databaseName' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'primaryKeyField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'resourceArn' => '<string>', // REQUIRED 'tableName' => '<string>', // REQUIRED ], 'redisEnterpriseCloudConfiguration' => [ 'credentialsSecretArn' => '<string>', // REQUIRED 'endpoint' => '<string>', // REQUIRED 'fieldMapping' => [ // REQUIRED 'metadataField' => '<string>', // REQUIRED 'textField' => '<string>', // REQUIRED 'vectorField' => '<string>', // REQUIRED ], 'vectorIndexName' => '<string>', // REQUIRED ], 'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', // REQUIRED ], ]);
Parameter Details
Members
- description
-
- Type: string
Specifies a new description for the knowledge base.
- knowledgeBaseConfiguration
-
- Required: Yes
- Type: KnowledgeBaseConfiguration structure
Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to update.
- name
-
- Required: Yes
- Type: string
Specifies a new name for the knowledge base.
- roleArn
-
- Required: Yes
- Type: string
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- storageConfiguration
-
- Required: Yes
- Type: StorageConfiguration structure
Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
Result Syntax
[ 'knowledgeBase' => [ 'createdAt' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'knowledgeBaseArn' => '<string>', 'knowledgeBaseConfiguration' => [ 'type' => 'VECTOR', 'vectorKnowledgeBaseConfiguration' => [ 'embeddingModelArn' => '<string>', 'embeddingModelConfiguration' => [ 'bedrockEmbeddingModelConfiguration' => [ 'dimensions' => <integer>, ], ], ], ], 'knowledgeBaseId' => '<string>', 'name' => '<string>', 'roleArn' => '<string>', 'status' => 'CREATING|ACTIVE|DELETING|UPDATING|FAILED|DELETE_UNSUCCESSFUL', 'storageConfiguration' => [ 'mongoDbAtlasConfiguration' => [ 'collectionName' => '<string>', 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'endpoint' => '<string>', 'endpointServiceName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'opensearchServerlessConfiguration' => [ 'collectionArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'pineconeConfiguration' => [ 'connectionString' => '<string>', 'credentialsSecretArn' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', ], 'namespace' => '<string>', ], 'rdsConfiguration' => [ 'credentialsSecretArn' => '<string>', 'databaseName' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'primaryKeyField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'resourceArn' => '<string>', 'tableName' => '<string>', ], 'redisEnterpriseCloudConfiguration' => [ 'credentialsSecretArn' => '<string>', 'endpoint' => '<string>', 'fieldMapping' => [ 'metadataField' => '<string>', 'textField' => '<string>', 'vectorField' => '<string>', ], 'vectorIndexName' => '<string>', ], 'type' => 'OPENSEARCH_SERVERLESS|PINECONE|REDIS_ENTERPRISE_CLOUD|RDS|MONGO_DB_ATLAS', ], 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- knowledgeBase
-
- Required: Yes
- Type: KnowledgeBase structure
Contains details about the knowledge base.
Errors
- ThrottlingException:
The number of requests exceeds the limit. Resubmit your request later.
- AccessDeniedException:
The request is denied because of missing access permissions.
- ValidationException:
Input validation failed. Check your request parameters and retry the request.
- InternalServerException:
An internal server error occurred. Retry your request.
- ResourceNotFoundException:
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- ConflictException:
There was a conflict performing an operation.
Shapes
APISchema
Description
Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload
field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3
field.
Members
- payload
-
- Type: string
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
- s3
-
- Type: S3Identifier structure
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
AccessDeniedException
Description
The request is denied because of missing access permissions.
Members
- message
-
- Type: string
ActionGroupExecutor
Description
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.
Members
- customControl
-
- Type: string
To return the action group invocation results directly in the
InvokeAgent
response, specifyRETURN_CONTROL
. - lambda
-
- Type: string
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
ActionGroupSummary
Description
Contains details about an action group.
Members
- actionGroupId
-
- Required: Yes
- Type: string
The unique identifier of the action group.
- actionGroupName
-
- Required: Yes
- Type: string
The name of the action group.
- actionGroupState
-
- Required: Yes
- Type: string
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- description
-
- Type: string
The description of the action group.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the action group was last updated.
Agent
Description
Contains details about an agent.
Members
- agentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the agent.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- agentName
-
- Required: Yes
- Type: string
The name of the agent.
- agentResourceRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent.
- clientToken
-
- Type: string
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.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the agent was created.
- customerEncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
- description
-
- Type: string
The description of the agent.
- failureReasons
-
- Type: Array of strings
Contains reasons that the agent-related API that you invoked failed.
- foundationModel
-
- Type: string
The foundation model used for orchestration by the agent.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The guardrails configuration assigned to the agent.
- idleSessionTTLInSeconds
-
- Required: Yes
- Type: int
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
- instruction
-
- Type: string
Instructions that tell the agent what it should do and how it should interact with users.
- preparedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the agent was last prepared.
- promptOverrideConfiguration
-
- Type: PromptOverrideConfiguration structure
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
- recommendedActions
-
- Type: Array of strings
Contains recommended actions to take for the agent-related API that you invoked to succeed.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the agent was last updated.
AgentActionGroup
Description
Contains details about an action group.
Members
- actionGroupExecutor
-
- Type: ActionGroupExecutor structure
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.
- actionGroupId
-
- Required: Yes
- Type: string
The unique identifier of the action group.
- actionGroupName
-
- Required: Yes
- Type: string
The name of the action group.
- actionGroupState
-
- Required: Yes
- Type: string
Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent to which the action group belongs.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent to which the action group belongs.
- apiSchema
-
- Type: APISchema structure
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
- clientToken
-
- Type: string
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.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the action group was created.
- description
-
- Type: string
The description of the action group.
- functionSchema
-
- Type: FunctionSchema structure
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
- parentActionSignature
-
- Type: string
If this field is set as
AMAZON.UserInput
, the agent can request the user for additional information when trying to complete a task. Thedescription
,apiSchema
, andactionGroupExecutor
fields must be blank for this action group.During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the action group was last updated.
AgentAlias
Description
Contains details about an alias of an agent.
Members
- agentAliasArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the alias of the agent.
- agentAliasHistoryEvents
-
- Type: Array of AgentAliasHistoryEvent structures
Contains details about the history of the alias.
- agentAliasId
-
- Required: Yes
- Type: string
The unique identifier of the alias of the agent.
- agentAliasName
-
- Required: Yes
- Type: string
The name of the alias of the agent.
- agentAliasStatus
-
- Required: Yes
- Type: string
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent alias is being created.
-
PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
-
FAILED – The agent alias API operation failed.
-
UPDATING – The agent alias is being updated.
-
DELETING – The agent alias is being deleted.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- clientToken
-
- Type: string
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.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alias of the agent was created.
- description
-
- Type: string
The description of the alias of the agent.
- failureReasons
-
- Type: Array of strings
Information on the failure of Provisioned Throughput assigned to an agent alias.
- routingConfiguration
-
- Required: Yes
- Type: Array of AgentAliasRoutingConfigurationListItem structures
Contains details about the routing configuration of the alias.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alias was last updated.
AgentAliasHistoryEvent
Description
Contains details about the history of the alias.
Members
- endDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the alias stopped being associated to the version in the
routingConfiguration
object - routingConfiguration
-
- Type: Array of AgentAliasRoutingConfigurationListItem structures
Contains details about the version of the agent with which the alias is associated.
- startDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the alias began being associated to the version in the
routingConfiguration
object.
AgentAliasRoutingConfigurationListItem
Description
Contains details about the routing configuration of the alias.
Members
- agentVersion
-
- Type: string
The version of the agent with which the alias is associated.
- provisionedThroughput
-
- Type: string
Information on the Provisioned Throughput assigned to an agent alias.
AgentAliasSummary
Description
Contains details about an alias of an agent.
Members
- agentAliasId
-
- Required: Yes
- Type: string
Contains details about
- agentAliasName
-
- Required: Yes
- Type: string
The name of the alias.
- agentAliasStatus
-
- Required: Yes
- Type: string
The status of the alias.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alias of the agent was created.
- description
-
- Type: string
The description of the alias.
- routingConfiguration
-
- Type: Array of AgentAliasRoutingConfigurationListItem structures
Contains details about the version of the agent with which the alias is associated.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the alias was last updated.
AgentKnowledgeBase
Description
Contains details about a knowledge base that is associated with an agent.
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent with which the knowledge base is associated.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent with which the knowledge base is associated.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the association between the agent and the knowledge base was created.
- description
-
- Required: Yes
- Type: string
The description of the association between the agent and the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the association between the agent and the knowledge base.
- knowledgeBaseState
-
- Required: Yes
- Type: string
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the association between the agent and the knowledge base was last updated.
AgentKnowledgeBaseSummary
Description
Contains details about a knowledge base associated with an agent.
Members
- description
-
- Type: string
The description of the knowledge base associated with an agent.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base associated with an agent.
- knowledgeBaseState
-
- Required: Yes
- Type: string
Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the knowledge base associated with an agent was last updated.
AgentSummary
Description
Contains details about an agent.
Members
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent.
- agentName
-
- Required: Yes
- Type: string
The name of the agent.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent.
- description
-
- Type: string
The description of the agent.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The details of the guardrails configuration in the agent summary.
- latestAgentVersion
-
- Type: string
The latest version of the agent.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the agent was last updated.
AgentVersion
Description
Contains details about a version of an agent.
Members
- agentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the agent that the version belongs to.
- agentId
-
- Required: Yes
- Type: string
The unique identifier of the agent that the version belongs to.
- agentName
-
- Required: Yes
- Type: string
The name of the agent that the version belongs to.
- agentResourceRoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent that the version belongs to.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the version was created.
- customerEncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
- description
-
- Type: string
The description of the version.
- failureReasons
-
- Type: Array of strings
A list of reasons that the API operation on the version failed.
- foundationModel
-
- Type: string
The foundation model that the version invokes.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The guardrails configuration assigned to the agent version.
- idleSessionTTLInSeconds
-
- Required: Yes
- Type: int
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
- instruction
-
- Type: string
The instructions provided to the agent.
- promptOverrideConfiguration
-
- Type: PromptOverrideConfiguration structure
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
- recommendedActions
-
- Type: Array of strings
A list of recommended actions to take for the failed API operation on the version to succeed.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the version was last updated.
- version
-
- Required: Yes
- Type: string
The version number.
AgentVersionSummary
Description
Contains details about a version of an agent.
Members
- agentName
-
- Required: Yes
- Type: string
The name of the agent to which the version belongs.
- agentStatus
-
- Required: Yes
- Type: string
The status of the agent to which the version belongs.
- agentVersion
-
- Required: Yes
- Type: string
The version of the agent.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the version was created.
- description
-
- Type: string
The description of the version of the agent.
- guardrailConfiguration
-
- Type: GuardrailConfiguration structure
The details of the guardrails configuration in the agent version summary.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the version was last updated.
BedrockEmbeddingModelConfiguration
Description
The vector configuration details for the Bedrock embeddings model.
Members
- dimensions
-
- Type: int
The dimensions details for the vector configuration used on the Bedrock embeddings model.
ChunkingConfiguration
Description
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.
Members
- chunkingStrategy
-
- Required: Yes
- Type: string
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 thefixedSizeChunkingConfiguration
. -
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.
- fixedSizeChunkingConfiguration
-
- Type: FixedSizeChunkingConfiguration structure
Configurations for when you choose fixed-size chunking. If you set the
chunkingStrategy
asNONE
, exclude this field.
ConflictException
Description
There was a conflict performing an operation.
Members
- message
-
- Type: string
DataSource
Description
Contains details about a data source.
Members
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the data source was created.
- dataDeletionPolicy
-
- Type: string
The data deletion policy for a data source.
- dataSourceConfiguration
-
- Required: Yes
- Type: DataSourceConfiguration structure
Contains details about how the data source is stored.
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source.
- description
-
- Type: string
The description of the data source.
- failureReasons
-
- Type: Array of strings
The detailed reasons on the failure to delete a data source.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source belongs.
- name
-
- Required: Yes
- Type: string
The name of the data source.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
Contains details about the configuration of the server-side encryption.
- status
-
- Required: Yes
- Type: string
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.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the data source was last updated.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in the data source.
DataSourceConfiguration
Description
Contains details about how a data source is stored.
Members
- s3Configuration
-
- Type: S3DataSourceConfiguration structure
Contains details about the configuration of the S3 object containing the data source.
- type
-
- Required: Yes
- Type: string
The type of storage for the data source.
DataSourceSummary
Description
Contains details about a data source.
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source.
- description
-
- Type: string
The description of the data source.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source belongs.
- name
-
- Required: Yes
- Type: string
The name of the data source.
- status
-
- Required: Yes
- Type: string
The status of the data source.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the data source was last updated.
EmbeddingModelConfiguration
Description
The configuration details for the embeddings model.
Members
- bedrockEmbeddingModelConfiguration
-
- Type: BedrockEmbeddingModelConfiguration structure
The vector configuration details on the Bedrock embeddings model.
FixedSizeChunkingConfiguration
Description
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
Members
- maxTokens
-
- Required: Yes
- Type: int
The maximum number of tokens to include in a chunk.
- overlapPercentage
-
- Required: Yes
- Type: int
The percentage of overlap between adjacent chunks of a data source.
Function
Description
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
This data type is used in the following API operations:
Members
- description
-
- Type: string
A description of the function and its purpose.
- name
-
- Required: Yes
- Type: string
A name for the function.
- parameters
-
- Type: Associative array of custom strings keys (Name) to ParameterDetail structures
The parameters that the agent elicits from the user to fulfill the function.
FunctionSchema
Description
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
Members
- functions
-
- Type: Array of Function structures
A list of functions that each define an action in the action group.
GuardrailConfiguration
Description
The details of the guardrails configuration.
Members
- guardrailIdentifier
-
- Type: string
The guardrails identifier assigned to the guardrails configuration.
- guardrailVersion
-
- Type: string
The guardrails version assigned to the guardrails configuration.
InferenceConfiguration
Description
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.
Members
- maximumLength
-
- Type: int
The maximum number of tokens to allow in the generated response.
- stopSequences
-
- Type: Array of strings
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
- temperature
-
- Type: float
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
- topK
-
- Type: int
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for
topK
is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you settopK
to 50, the model selects the next token from among the top 50 most likely choices. - topP
-
- Type: float
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for
Top P
determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you settopP
to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
IngestionJob
Description
Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the ingested data source.
- description
-
- Type: string
The description of the ingestion job.
- failureReasons
-
- Type: Array of strings
A list of reasons that the ingestion job failed.
- ingestionJobId
-
- Required: Yes
- Type: string
The unique identifier of the ingestion job.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source is being added.
- startedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the ingestion job started.
- statistics
-
- Type: IngestionJobStatistics structure
Contains statistics about the ingestion job.
- status
-
- Required: Yes
- Type: string
The status of the ingestion job.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the ingestion job was last updated.
IngestionJobFilter
Description
Defines a filter by which to filter the results.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute by which to filter the results.
- operator
-
- Required: Yes
- Type: string
The operation to carry out between the attribute and the values.
- values
-
- Required: Yes
- Type: Array of strings
A list of values for the attribute.
IngestionJobSortBy
Description
Parameters by which to sort the results.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute by which to sort the results.
- order
-
- Required: Yes
- Type: string
The order by which to sort the results.
IngestionJobStatistics
Description
Contains the statistics for the ingestion job.
Members
- numberOfDocumentsDeleted
-
- Type: long (int|float)
The number of source documents that was deleted.
- numberOfDocumentsFailed
-
- Type: long (int|float)
The number of source documents that failed to be ingested.
- numberOfDocumentsScanned
-
- Type: long (int|float)
The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
- numberOfMetadataDocumentsModified
-
- Type: long (int|float)
The number of metadata files that were updated or deleted.
- numberOfMetadataDocumentsScanned
-
- Type: long (int|float)
The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
- numberOfModifiedDocumentsIndexed
-
- Type: long (int|float)
The number of modified source documents in the data source that were successfully indexed.
- numberOfNewDocumentsIndexed
-
- Type: long (int|float)
The number of new source documents in the data source that were successfully indexed.
IngestionJobSummary
Description
Contains details about an ingestion job.
Members
- dataSourceId
-
- Required: Yes
- Type: string
The unique identifier of the data source in the ingestion job.
- description
-
- Type: string
The description of the ingestion job.
- ingestionJobId
-
- Required: Yes
- Type: string
The unique identifier of the ingestion job.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base to which the data source is added.
- startedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the ingestion job was started.
- statistics
-
- Type: IngestionJobStatistics structure
Contains statistics for the ingestion job.
- status
-
- Required: Yes
- Type: string
The status of the ingestion job.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the ingestion job was last updated.
InternalServerException
Description
An internal server error occurred. Retry your request.
Members
- message
-
- Type: string
KnowledgeBase
Description
Contains information about a knowledge base.
Members
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the knowledge base was created.
- description
-
- Type: string
The description of the knowledge base.
- failureReasons
-
- Type: Array of strings
A list of reasons that the API operation on the knowledge base failed.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseConfiguration
-
- Required: Yes
- Type: KnowledgeBaseConfiguration structure
Contains details about the embeddings configuration of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
- storageConfiguration
-
- Required: Yes
- Type: StorageConfiguration structure
Contains details about the storage configuration of the knowledge base.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the knowledge base was last updated.
KnowledgeBaseConfiguration
Description
Contains details about the embeddings configuration of the knowledge base.
Members
- type
-
- Required: Yes
- Type: string
The type of data that the data source is converted into for the knowledge base.
- vectorKnowledgeBaseConfiguration
-
- Type: VectorKnowledgeBaseConfiguration structure
Contains details about the embeddings model that'sused to convert the data source.
KnowledgeBaseSummary
Description
Contains details about a knowledge base.
Members
- description
-
- Type: string
The description of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The unique identifier of the knowledge base.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the knowledge base was last updated.
MongoDbAtlasConfiguration
Description
Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
Members
- collectionName
-
- Required: Yes
- Type: string
The collection name of the knowledge base in MongoDB Atlas.
- credentialsSecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
- databaseName
-
- Required: Yes
- Type: string
The database name in your MongoDB Atlas cluster for your knowledge base.
- endpoint
-
- Required: Yes
- Type: string
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
- endpointServiceName
-
- Type: string
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
- fieldMapping
-
- Required: Yes
- Type: MongoDbAtlasFieldMapping structure
Contains the names of the fields to which to map information about the vector store.
- vectorIndexName
-
- Required: Yes
- Type: string
The name of the MongoDB Atlas vector search index.
MongoDbAtlasFieldMapping
Description
Contains the names of the fields to which to map information about the vector store.
Members
- metadataField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
- textField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vectorField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
OpenSearchServerlessConfiguration
Description
Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
Members
- collectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
- fieldMapping
-
- Required: Yes
- Type: OpenSearchServerlessFieldMapping structure
Contains the names of the fields to which to map information about the vector store.
- vectorIndexName
-
- Required: Yes
- Type: string
The name of the vector store.
OpenSearchServerlessFieldMapping
Description
Contains the names of the fields to which to map information about the vector store.
Members
- metadataField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
- textField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vectorField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
ParameterDetail
Description
Contains details about a parameter in a function for an action group.
This data type is used in the following API operations:
Members
- description
-
- Type: string
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
- required
-
- Type: boolean
Whether the parameter is required for the agent to complete the function for action group invocation.
- type
-
- Required: Yes
- Type: string
The data type of the parameter.
PineconeConfiguration
Description
Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
Members
- connectionString
-
- Required: Yes
- Type: string
The endpoint URL for your index management page.
- credentialsSecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
- fieldMapping
-
- Required: Yes
- Type: PineconeFieldMapping structure
Contains the names of the fields to which to map information about the vector store.
- namespace
-
- Type: string
The namespace to be used to write new data to your database.
PineconeFieldMapping
Description
Contains the names of the fields to which to map information about the vector store.
Members
- metadataField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
- textField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
PromptConfiguration
Description
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
Members
- basePromptTemplate
-
- Type: string
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.
- inferenceConfiguration
-
- Type: InferenceConfiguration structure
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. - parserMode
-
- Type: string
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 asOVERRIDEN
, theoverrideLambda
field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function. - promptCreationMode
-
- Type: string
Specifies whether to override the default prompt template for this
promptType
. Set this value toOVERRIDDEN
to use the prompt that you provide in thebasePromptTemplate
. If you leave it asDEFAULT
, the agent uses a default prompt template. - promptState
-
- Type: string
Specifies whether to allow the agent to carry out the step specified in the
promptType
. If you set this value toDISABLED
, the agent skips that step. The default state for eachpromptType
is as follows.-
PRE_PROCESSING
–ENABLED
-
ORCHESTRATION
–ENABLED
-
KNOWLEDGE_BASE_RESPONSE_GENERATION
–ENABLED
-
POST_PROCESSING
–DISABLED
- promptType
-
- Type: string
The step in the agent sequence that this prompt configuration applies to.
PromptOverrideConfiguration
Description
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
Members
- overrideLambda
-
- Type: string
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 aparserMode
value that is set toOVERRIDDEN
. For more information, see Parser Lambda function in Agents for Amazon Bedrock. - promptConfigurations
-
- Required: Yes
- Type: Array of PromptConfiguration structures
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
RdsConfiguration
Description
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
Members
- credentialsSecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
- databaseName
-
- Required: Yes
- Type: string
The name of your Amazon RDS database.
- fieldMapping
-
- Required: Yes
- Type: RdsFieldMapping structure
Contains the names of the fields to which to map information about the vector store.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the vector store.
- tableName
-
- Required: Yes
- Type: string
The name of the table in the database.
RdsFieldMapping
Description
Contains the names of the fields to which to map information about the vector store.
Members
- metadataField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
- primaryKeyField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the ID for each entry.
- textField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vectorField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
RedisEnterpriseCloudConfiguration
Description
Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
Members
- credentialsSecretArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
- endpoint
-
- Required: Yes
- Type: string
The endpoint URL of the Redis Enterprise Cloud database.
- fieldMapping
-
- Required: Yes
- Type: RedisEnterpriseCloudFieldMapping structure
Contains the names of the fields to which to map information about the vector store.
- vectorIndexName
-
- Required: Yes
- Type: string
The name of the vector index.
RedisEnterpriseCloudFieldMapping
Description
Contains the names of the fields to which to map information about the vector store.
Members
- metadataField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores metadata about the vector store.
- textField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- vectorField
-
- Required: Yes
- Type: string
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
ResourceNotFoundException
Description
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Members
- message
-
- Type: string
S3DataSourceConfiguration
Description
Contains information about the S3 configuration of the data source.
Members
- bucketArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bucket that contains the data source.
- bucketOwnerAccountId
-
- Type: string
The bucket account owner ID for the S3 bucket.
- inclusionPrefixes
-
- Type: Array of strings
A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
S3Identifier
Description
Contains information about the S3 object containing the resource.
Members
- s3BucketName
-
- Type: string
The name of the S3 bucket.
- s3ObjectKey
-
- Type: string
The S3 object key containing the resource.
ServerSideEncryptionConfiguration
Description
Contains the configuration for server-side encryption.
Members
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
ServiceQuotaExceededException
Description
The number of requests exceeds the service quota. Resubmit your request later.
Members
- message
-
- Type: string
StorageConfiguration
Description
Contains the storage configuration of the knowledge base.
Members
- mongoDbAtlasConfiguration
-
- Type: MongoDbAtlasConfiguration structure
Contains the storage configuration of the knowledge base in MongoDB Atlas.
- opensearchServerlessConfiguration
-
- Type: OpenSearchServerlessConfiguration structure
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
- pineconeConfiguration
-
- Type: PineconeConfiguration structure
Contains the storage configuration of the knowledge base in Pinecone.
- rdsConfiguration
-
- Type: RdsConfiguration structure
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
- redisEnterpriseCloudConfiguration
-
- Type: RedisEnterpriseCloudConfiguration structure
Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
- type
-
- Required: Yes
- Type: string
The vector store service in which the knowledge base is stored.
ThrottlingException
Description
The number of requests exceeds the limit. Resubmit your request later.
Members
- message
-
- Type: string
ValidationException
Description
Input validation failed. Check your request parameters and retry the request.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
- message
-
- Type: string
ValidationExceptionField
Description
Stores information about a field passed inside a request that resulted in an validation error.
Members
- message
-
- Required: Yes
- Type: string
A message describing why this field failed validation.
- name
-
- Required: Yes
- Type: string
The name of the field.
VectorIngestionConfiguration
Description
Contains details about how to ingest the documents in a data source.
Members
- chunkingConfiguration
-
- Type: ChunkingConfiguration structure
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.
VectorKnowledgeBaseConfiguration
Description
Contains details about the model used to create vector embeddings for the knowledge base.
Members
- embeddingModelArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
- embeddingModelConfiguration
-
- Type: EmbeddingModelConfiguration structure
The embeddings model configuration details for the vector model used in Knowledge Base.