AssociateAgentKnowledgeBase
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.
Request Syntax
PUT /agents/agentId/agentversions/agentVersion/knowledgebases/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string"
}URI Request Parameters
The request uses the following URI parameters.
- agentId
-
The unique identifier of the agent with which you want to associate the knowledge base.
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- agentVersion
-
The version of the agent with which you want to associate the knowledge base.
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
A description of what the agent should use the knowledge base for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
- knowledgeBaseId
-
The unique identifier of the knowledge base to associate with the agent.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- knowledgeBaseState
-
Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"agentKnowledgeBase": {
"agentId": "string",
"agentVersion": "string",
"createdAt": "string",
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string",
"updatedAt": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- agentKnowledgeBase
-
Contains details about the knowledge base that has been associated with the agent.
Type: AgentKnowledgeBase object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- ConflictException
-
There was a conflict performing an operation.
HTTP Status Code: 409
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
