AgentsforBedrock / Client / create_prompt_version

create_prompt_version¶

AgentsforBedrock.Client.create_prompt_version(**kwargs)¶

Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.

Request Syntax

response = client.create_prompt_version(
    promptIdentifier='string',
    description='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)

Parameters:

promptIdentifier (string) –
[REQUIRED]

The unique identifier of the prompt that you want to create a version of.
description (string) – A description for the version of the prompt.
clientToken (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.

This field is autopopulated if not provided.
tags (dict) –
Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'customerEncryptionKeyArn': 'string',
    'defaultVariant': 'string',
    'variants': [
        {
            'name': 'string',
            'templateType': 'TEXT'|'CHAT',
            'templateConfiguration': {
                'text': {
                    'text': 'string',
                    'cachePoint': {
                        'type': 'default'
                    },
                    'inputVariables': [
                        {
                            'name': 'string'
                        },
                    ]
                },
                'chat': {
                    'messages': [
                        {
                            'role': 'user'|'assistant',
                            'content': [
                                {
                                    'text': 'string',
                                    'cachePoint': {
                                        'type': 'default'
                                    }
                                },
                            ]
                        },
                    ],
                    'system': [
                        {
                            'text': 'string',
                            'cachePoint': {
                                'type': 'default'
                            }
                        },
                    ],
                    'inputVariables': [
                        {
                            'name': 'string'
                        },
                    ],
                    'toolConfiguration': {
                        'tools': [
                            {
                                'toolSpec': {
                                    'name': 'string',
                                    'description': 'string',
                                    'inputSchema': {
                                        'json': {...}|[...]|123|123.4|'string'|True|None
                                    }
                                },
                                'cachePoint': {
                                    'type': 'default'
                                }
                            },
                        ],
                        'toolChoice': {
                            'auto': {},
                            'any': {},
                            'tool': {
                                'name': 'string'
                            }
                        }
                    }
                }
            },
            'modelId': 'string',
            'inferenceConfiguration': {
                'text': {
                    'temperature': ...,
                    'topP': ...,
                    'maxTokens': 123,
                    'stopSequences': [
                        'string',
                    ]
                }
            },
            'metadata': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'additionalModelRequestFields': {...}|[...]|123|123.4|'string'|True|None,
            'genAiResource': {
                'agent': {
                    'agentIdentifier': 'string'
                }
            }
        },
    ],
    'id': 'string',
    'arn': 'string',
    'version': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- name (string) –
  
  The name of the prompt.
- description (string) –
  
  A description for the version.
- customerEncryptionKeyArn (string) –
  
  The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
- defaultVariant (string) –
  
  The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
- variants (list) –
  
  A list of objects, each containing details about a variant of the prompt.
  - (dict) –
    
    Contains details about a variant of the prompt.
    - name (string) –
      
      The name of the prompt variant.
    - templateType (string) –
      
      The type of prompt template to use.
    - templateConfiguration (dict) –
      
      Contains configurations for the prompt template.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: text, chat. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - text (dict) –
        
        Contains configurations for the text in a message for a prompt.
        
        text (string) –
        
        The message for the prompt.
        
        cachePoint (dict) –
        
        A cache checkpoint within a template configuration.
        
        type (string) –
        
        Indicates that the CachePointBlock is of the default type
        
        inputVariables (list) –
        
        An array of the variables in the prompt template.
        
        (dict) –
        
        Contains information about a variable in the prompt.
        
        name (string) –
        
        The name of the variable.
      - chat (dict) –
        
        Contains configurations to use the prompt in a conversational format.
        
        messages (list) –
        
        Contains messages in the chat for the prompt.
        
        (dict) –
        
        A message input or response from a model. For more information, see Create a prompt using Prompt management.
        
        role (string) –
        
        The role that the message belongs to.
        
        content (list) –
        
        The content in the message.
        
        (dict) –
        
        Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: text, cachePoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        text (string) –
        
        The text in the message.
        
        cachePoint (dict) –
        
        Creates a cache checkpoint within a message.
        
        type (string) –
        
        Indicates that the CachePointBlock is of the default type
        
        system (list) –
        
        Contains system prompts to provide context to the model or to describe how it should behave.
        
        (dict) –
        
        Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: text, cachePoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        text (string) –
        
        The text in the system prompt.
        
        cachePoint (dict) –
        
        Creates a cache checkpoint within a tool designation
        
        type (string) –
        
        Indicates that the CachePointBlock is of the default type
        
        inputVariables (list) –
        
        An array of the variables in the prompt template.
        
        (dict) –
        
        Contains information about a variable in the prompt.
        
        name (string) –
        
        The name of the variable.
        
        toolConfiguration (dict) –
        
        Configuration information for the tools that the model can use when generating a response.
        
        tools (list) –
        
        An array of tools to pass to a model.
        
        (dict) –
        
        Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: toolSpec, cachePoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        toolSpec (dict) –
        
        The specification for the tool.
        
        name (string) –
        
        The name of the tool.
        
        description (string) –
        
        The description of the tool.
        
        inputSchema (dict) –
        
        The input schema for the tool.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: json. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        json (document) –
        
        A JSON object defining the input schema for the tool.
        
        cachePoint (dict) –
        
        Creates a cache checkpoint within a tool designation
        
        type (string) –
        
        Indicates that the CachePointBlock is of the default type
        
        toolChoice (dict) –
        
        Defines which tools the model should request when invoked.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: auto, any, tool. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        auto (dict) –
        
        Defines tools. The model automatically decides whether to call a tool or to generate text instead.
        
        any (dict) –
        
        Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.
        
        tool (dict) –
        
        Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.
        
        name (string) –
        
        The name of the tool.
    - modelId (string) –
      
      The unique identifier of the model or inference profile with which to run inference on the prompt.
    - inferenceConfiguration (dict) –
      
      Contains inference configurations for the prompt variant.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: text. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - text (dict) –
        
        Contains inference configurations for a text prompt.
        
        temperature (float) –
        
        Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
        
        topP (float) –
        
        The percentage of most-likely candidates that the model considers for the next token.
        
        maxTokens (integer) –
        
        The maximum number of tokens to return in the response.
        
        stopSequences (list) –
        
        A list of strings that define sequences after which the model will stop generating.
        
        (string) –
    - metadata (list) –
      
      An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
      - (dict) –
        
        Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management.
        
        key (string) –
        
        The key of a metadata tag for a prompt variant.
        
        value (string) –
        
        The value of a metadata tag for a prompt variant.
    - additionalModelRequestFields (document) –
      
      Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
    - genAiResource (dict) –
      
      Specifies a generative AI resource with which to use the prompt.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: agent. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - agent (dict) –
        
        Specifies an Amazon Bedrock agent with which to use the prompt.
        
        agentIdentifier (string) –
        
        The ARN of the agent with which to use the prompt.
- id (string) –
  
  The unique identifier of the prompt.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the version of the prompt.
- version (string) –
  
  The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
- createdAt (datetime) –
  
  The time at which the prompt was created.
- updatedAt (datetime) –
  
  The time at which the prompt was last updated.

Exceptions

AgentsforBedrock.Client.exceptions.ThrottlingException
AgentsforBedrock.Client.exceptions.AccessDeniedException
AgentsforBedrock.Client.exceptions.ValidationException
AgentsforBedrock.Client.exceptions.InternalServerException
AgentsforBedrock.Client.exceptions.ResourceNotFoundException
AgentsforBedrock.Client.exceptions.ConflictException
AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException