AgentsforBedrock / Client / get_agent_version

get_agent_version#

AgentsforBedrock.Client.get_agent_version(**kwargs)#

Gets details about a version of an agent.

Request Syntax

response = client.get_agent_version(
    agentId='string',
    agentVersion='string'
)

Parameters:

agentId (string) –
[REQUIRED]

The unique identifier of the agent.
agentVersion (string) –
[REQUIRED]

The version of the agent.

Return type:

dict

Returns:

Response Syntax

{
    'agentVersion': {
        'agentArn': 'string',
        'agentId': 'string',
        'agentName': 'string',
        'agentResourceRoleArn': 'string',
        'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING',
        'createdAt': datetime(2015, 1, 1),
        'customerEncryptionKeyArn': 'string',
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'foundationModel': 'string',
        'idleSessionTTLInSeconds': 123,
        'instruction': 'string',
        'promptOverrideConfiguration': {
            'overrideLambda': 'string',
            'promptConfigurations': [
                {
                    'basePromptTemplate': 'string',
                    'inferenceConfiguration': {
                        'maximumLength': 123,
                        'stopSequences': [
                            'string',
                        ],
                        'temperature': ...,
                        'topK': 123,
                        'topP': ...
                    },
                    'parserMode': 'DEFAULT'|'OVERRIDDEN',
                    'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
                    'promptState': 'ENABLED'|'DISABLED',
                    'promptType': 'PRE_PROCESSING'|'ORCHESTRATION'|'POST_PROCESSING'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'
                },
            ]
        },
        'recommendedActions': [
            'string',
        ],
        'updatedAt': datetime(2015, 1, 1),
        'version': 'string'
    }
}

Response Structure

(dict) –
- agentVersion (dict) –
  
  Contains details about the version of the agent.
  - agentArn (string) –
    
    The Amazon Resource Name (ARN) of the agent that the version belongs to.
  - agentId (string) –
    
    The unique identifier of the agent that the version belongs to.
  - agentName (string) –
    
    The name of the agent that the version belongs to.
  - agentResourceRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  - agentStatus (string) –
    
    The status of the agent that the version belongs to.
  - createdAt (datetime) –
    
    The time at which the version was created.
  - customerEncryptionKeyArn (string) –
    
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  - description (string) –
    
    The description of the version.
  - failureReasons (list) –
    
    A list of reasons that the API operation on the version failed.
    - (string) –
  - foundationModel (string) –
    
    The foundation model that the version invokes.
  - idleSessionTTLInSeconds (integer) –
    
    The number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.
    
    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  - instruction (string) –
    
    The instructions provided to the agent.
  - promptOverrideConfiguration (dict) –
    
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    - overrideLambda (string) –
      
      The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.
    - promptConfigurations (list) –
      
      Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
      - (dict) –
        
        Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
        
        basePromptTemplate (string) –
        
        Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.
        
        inferenceConfiguration (dict) –
        
        Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
        
        maximumLength (integer) –
        
        The maximum number of tokens to allow in the generated response.
        
        stopSequences (list) –
        
        A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
        
        (string) –
        
        temperature (float) –
        
        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.
        
        topK (integer) –
        
        While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
        
        topP (float) –
        
        While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
        
        parserMode (string) –
        
        Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
        
        promptCreationMode (string) –
        
        Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
        
        promptState (string) –
        
        Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
        
        PRE_PROCESSING – ENABLED
        
        ORCHESTRATION – ENABLED
        
        KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
        
        POST_PROCESSING – DISABLED
        
        promptType (string) –
        
        The step in the agent sequence that this prompt configuration applies to.
  - recommendedActions (list) –
    
    A list of recommended actions to take for the failed API operation on the version to succeed.
    - (string) –
  - updatedAt (datetime) –
    
    The time at which the version was last updated.
  - version (string) –
    
    The version number.

get_agent_version#

Request Syntax

Response Syntax

Response Structure

Exceptions