OptimizePrompt
Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
Request Syntax
POST /optimize-prompt HTTP/1.1
Content-type: application/json
{
"input": { ... },
"targetModelId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- input
-
Contains the prompt to optimize.
Type: InputPrompt object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- targetModelId
-
The unique identifier of the model that you want to optimize the prompt for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"accessDeniedException": {
},
"analyzePromptEvent": {
"message": "string"
},
"badGatewayException": {
},
"dependencyFailedException": {
},
"internalServerException": {
},
"optimizedPromptEvent": {
"optimizedPrompt": { ... }
},
"throttlingException": {
},
"validationException": {
}
}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.
- accessDeniedException
-
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403 - analyzePromptEvent
-
An event in which the prompt was analyzed in preparation for optimization.
Type: AnalyzePromptEvent object
- badGatewayException
-
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502 - dependencyFailedException
-
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424 - internalServerException
-
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500 - optimizedPromptEvent
-
An event in which the prompt was optimized.
Type: OptimizedPromptEvent object
- throttlingException
-
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.
Type: Exception
HTTP Status Code: 429 - validationException
-
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
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. Check your permissions and retry your request.
HTTP Status Code: 403
- BadGatewayException
-
There was an issue with a dependency due to a server issue. Retry your request.
HTTP Status Code: 502
- DependencyFailedException
-
There was an issue with a dependency. Check the resource configurations and retry the request.
HTTP Status Code: 424
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- 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
Examples
Example
This example illustrates one usage of OptimizePrompt.
POST /optimize-prompt HTTP/1.1
Content-type: application/json
{
"input": {
"textPrompt": {
"text": "Please summarize this text: "
}
},
"targetModelId": "anthropic.claude-3-sonnet-20240229-v1:0"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
