Amazon Bedrock Bedrock Advanced Prompt Optimization Jobs API

openapi: 3.2.0
info:
  title: Amazon Bedrock Advanced Prompt Optimization Jobs API
  version: '2023-04-20'
  description: Generated from AWS's published Smithy model for Amazon Bedrock. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://bedrock.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Advanced Prompt Optimization Jobs
paths:
  /advanced-prompt-optimization-jobs:
    post:
      operationId: CreateAdvancedPromptOptimizationJob
      summary: Create Advanced Prompt Optimization Job
      description: Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAdvancedPromptOptimizationJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ConflictException; ServiceQuotaExceededException; TooManyTagsException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAdvancedPromptOptimizationJobRequest'
      tags:
      - Advanced Prompt Optimization Jobs
    get:
      operationId: ListAdvancedPromptOptimizationJobs
      summary: List Advanced Prompt Optimization Jobs
      description: Lists the advanced prompt optimization jobs in your account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAdvancedPromptOptimizationJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAdvancedPromptOptimizationJobsRequest'
      tags:
      - Advanced Prompt Optimization Jobs
  /advanced-prompt-optimization-jobs/{jobIdentifier}:
    get:
      operationId: GetAdvancedPromptOptimizationJob
      summary: Get Advanced Prompt Optimization Job
      description: Gets information about an advanced prompt optimization job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAdvancedPromptOptimizationJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAdvancedPromptOptimizationJobRequest'
      tags:
      - Advanced Prompt Optimization Jobs
components:
  schemas:
    AdvancedPromptOptimizationInputConfig:
      type: object
      properties:
        s3Uri:
          type: string
          description: The S3 URI of the JSONL input file containing prompt templates and evaluation samples.
      required:
      - s3Uri
    AdvancedPromptOptimizationOutputConfig:
      type: object
      properties:
        s3Uri:
          type: string
          description: The S3 URI prefix where the optimization results will be written.
      required:
      - s3Uri
    ModelConfiguration:
      type: object
      properties:
        modelId:
          type: string
          description: 'The model to use for optimization. The value depends on the resource that you use: If you use a base model, specify the model ID or its ARN. For a list of model IDs, see Models at a glance in the Amazon Bedrock User Guide. If you use a cross-Region (system-defined) inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for inference profiles in the Amazon Bedrock User Guide. If you use an application inference profile, specify its full ARN, including the account ID and Region.'
        inferenceConfig:
          $ref: '#/components/schemas/InferenceConfiguration'
        additionalModelRequestFields:
          type: object
          additionalProperties:
            type: object
          description: Additional model request fields. Use this to pass model-specific parameters that are not included in the standard inference configuration.
      required:
      - modelId
    InferenceConfiguration:
      type: object
      properties:
        maxTokens:
          type: integer
          description: The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using.
        temperature:
          type: number
          description: 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.
        topP:
          type: number
          description: The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
        stopSequences:
          type: array
          items:
            type: string
          description: A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
    ValidationException:
      type: object
      properties:
        message:
          type: string
    ListAdvancedPromptOptimizationJobsResponse:
      type: object
      properties:
        jobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/AdvancedPromptOptimizationJobSummary'
          description: A list of advanced prompt optimization job summaries.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
    ConflictException:
      type: object
      properties:
        message:
          type: string
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    GetAdvancedPromptOptimizationJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the advanced prompt optimization job.
        jobName:
          type: string
          description: The name of the advanced prompt optimization job.
        jobDescription:
          type: string
          description: The description of the advanced prompt optimization job.
        jobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - PartiallyCompleted
          - Stopping
          - Stopped
          - Deleting
          description: The status of the advanced prompt optimization job.
        inputConfig:
          $ref: '#/components/schemas/AdvancedPromptOptimizationInputConfig'
        outputConfig:
          $ref: '#/components/schemas/AdvancedPromptOptimizationOutputConfig'
        encryptionKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.
        creationTime:
          type: string
          format: date-time
          description: The time at which the advanced prompt optimization job was created.
        lastModifiedTime:
          type: string
          format: date-time
          description: The time at which the advanced prompt optimization job was last modified.
        failureMessage:
          type: string
          description: If the job failed, a message describing the reason for the failure.
        modelConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ModelConfiguration'
          description: The model configurations used in the optimization job.
      required:
      - jobArn
      - jobName
      - jobStatus
      - inputConfig
      - outputConfig
      - creationTime
      - modelConfigurations
    ListAdvancedPromptOptimizationJobsRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of results to return in the response.
        nextToken:
          type: string
          description: If the total number of results is greater than the maxResults value provided in the request, use this token in a subsequent request to get the next set of results.
        sortBy:
          type: string
          enum:
          - CreationTime
          description: The field to sort the results by.
        sortOrder:
          type: string
          enum:
          - Ascending
          - Descending
          description: The sort order for the results.
    Tag:
      type: object
      properties:
        key:
          type: string
          description: Key for the tag.
        value:
          type: string
          description: Value for the tag.
      required:
      - key
      - value
    GetAdvancedPromptOptimizationJobRequest:
      type: object
      properties:
        jobIdentifier:
          type: string
          description: The ARN or ID of the advanced prompt optimization job.
      required:
      - jobIdentifier
    AdvancedPromptOptimizationJobSummary:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the job.
        jobName:
          type: string
          description: The name of the job.
        jobStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - PartiallyCompleted
          - Stopping
          - Stopped
          - Deleting
          description: The status of the job.
        creationTime:
          type: string
          format: date-time
          description: The time at which the job was created.
        lastModifiedTime:
          type: string
          format: date-time
          description: The time at which the job was last modified.
      required:
      - jobArn
      - jobName
      - jobStatus
      - creationTime
    CreateAdvancedPromptOptimizationJobResponse:
      type: object
      properties:
        jobArn:
          type: string
          description: The Amazon Resource Name (ARN) of the created advanced prompt optimization job.
      required:
      - jobArn
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    CreateAdvancedPromptOptimizationJobRequest:
      type: object
      properties:
        jobName:
          type: string
          description: A name for the advanced prompt optimization job.
        jobDescription:
          type: string
          description: A description of the advanced prompt optimization job.
        clientToken:
          type: string
          description: 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.
        inputConfig:
          $ref: '#/components/schemas/AdvancedPromptOptimizationInputConfig'
        outputConfig:
          $ref: '#/components/schemas/AdvancedPromptOptimizationOutputConfig'
        encryptionKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Tags to associate with the advanced prompt optimization job.
        modelConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ModelConfiguration'
          description: A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.
      required:
      - jobName
      - inputConfig
      - outputConfig
      - modelConfigurations
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: bedrock
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)