get_prompt#

AgentsforBedrock.Client.get_prompt(**kwargs)#

Retrieves information about the working draft ( DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.

Request Syntax

response = client.get_prompt(
    promptIdentifier='string',
    promptVersion='string'
)

Parameters:

promptIdentifier (string) –
[REQUIRED]

The unique identifier of the prompt.
promptVersion (string) – The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'customerEncryptionKeyArn': 'string',
    'defaultVariant': 'string',
    'description': 'string',
    'id': 'string',
    'name': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'variants': [
        {
            'additionalModelRequestFields': {...}|[...]|123|123.4|'string'|True|None,
            'inferenceConfiguration': {
                'text': {
                    'maxTokens': 123,
                    'stopSequences': [
                        'string',
                    ],
                    'temperature': ...,
                    'topP': ...
                }
            },
            'metadata': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'modelId': 'string',
            'name': 'string',
            'templateConfiguration': {
                'text': {
                    'inputVariables': [
                        {
                            'name': 'string'
                        },
                    ],
                    'text': 'string'
                }
            },
            'templateType': 'TEXT'
        },
    ],
    'version': 'string'
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
- createdAt (datetime) –
  
  The time at which the prompt was created.
- customerEncryptionKeyArn (string) –
  
  The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
- defaultVariant (string) –
  
  The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.
- description (string) –
  
  The descriptino of the prompt.
- id (string) –
  
  The unique identifier of the prompt.
- name (string) –
  
  The name of the prompt.
- updatedAt (datetime) –
  
  The time at which the prompt was last updated.
- variants (list) –
  
  A list of objects, each containing details about a variant of the prompt.
  - (dict) –
    
    Contains details about a variant of the prompt.
    - 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.
    - 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.
        
        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) –
        
        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.
    - 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. For more information, see Create a prompt using Prompt management.
      - (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.
    - modelId (string) –
      
      The unique identifier of the model or inference profile with which to run inference on the prompt.
    - name (string) –
      
      The name of the prompt variant.
    - 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. 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.
        
        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.
        
        text (string) –
        
        The message for the prompt.
    - templateType (string) –
      
      The type of prompt template to use.
- version (string) –
  
  The version of the prompt.

Exceptions

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