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': {
        'agentId': 'string',
        'agentName': 'string',
        'agentArn': 'string',
        'version': 'string',
        'instruction': 'string',
        'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING',
        'foundationModel': 'string',
        'description': 'string',
        'idleSessionTTLInSeconds': 123,
        'agentResourceRoleArn': 'string',
        'customerEncryptionKeyArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'failureReasons': [
            'string',
        ],
        'recommendedActions': [
            'string',
        ],
        'promptOverrideConfiguration': {
            'promptConfigurations': [
                {
                    'promptType': 'PRE_PROCESSING'|'ORCHESTRATION'|'POST_PROCESSING'|'KNOWLEDGE_BASE_RESPONSE_GENERATION'|'MEMORY_SUMMARIZATION',
                    'promptCreationMode': 'DEFAULT'|'OVERRIDDEN',
                    'promptState': 'ENABLED'|'DISABLED',
                    'basePromptTemplate': 'string',
                    'inferenceConfiguration': {
                        'temperature': ...,
                        'topP': ...,
                        'topK': 123,
                        'maximumLength': 123,
                        'stopSequences': [
                            'string',
                        ]
                    },
                    'parserMode': 'DEFAULT'|'OVERRIDDEN',
                    'foundationModel': 'string',
                    'additionalModelRequestFields': {...}|[...]|123|123.4|'string'|True|None
                },
            ],
            'overrideLambda': 'string'
        },
        'guardrailConfiguration': {
            'guardrailIdentifier': 'string',
            'guardrailVersion': 'string'
        },
        'memoryConfiguration': {
            'enabledMemoryTypes': [
                'SESSION_SUMMARY',
            ],
            'storageDays': 123,
            'sessionSummaryConfiguration': {
                'maxRecentSessions': 123
            }
        },
        'agentCollaboration': 'SUPERVISOR'|'SUPERVISOR_ROUTER'|'DISABLED'
    }
}

Response Structure

(dict) –
- agentVersion (dict) –
  
  Contains details about the version of the agent.
  - 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.
  - agentArn (string) –
    
    The Amazon Resource Name (ARN) of the agent that the version belongs to.
  - version (string) –
    
    The version number.
  - instruction (string) –
    
    The instructions provided to the agent.
  - agentStatus (string) –
    
    The status of the agent that the version belongs to.
  - foundationModel (string) –
    
    The foundation model that the version invokes.
  - description (string) –
    
    The description of the version.
  - 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.
  - agentResourceRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
  - customerEncryptionKeyArn (string) –
    
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  - createdAt (datetime) –
    
    The time at which the version was created.
  - updatedAt (datetime) –
    
    The time at which the version was last updated.
  - failureReasons (list) –
    
    A list of reasons that the API operation on the version failed.
    - (string) –
  - recommendedActions (list) –
    
    A list of recommended actions to take for the failed API operation on the version to succeed.
    - (string) –
  - promptOverrideConfiguration (dict) –
    
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    - 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.
        
        promptType (string) –
        
        The step in the agent sequence that this prompt configuration applies to.
        
        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 – DISABLED
        
        ORCHESTRATION – ENABLED
        
        KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
        
        POST_PROCESSING – DISABLED
        
        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. For more information, see Configure the prompt templates.
        
        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.
        
        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.
        
        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 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
        
        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.
        
        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) –
        
        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 OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
        
        foundationModel (string) –
        
        The agent’s foundation model.
        
        additionalModelRequestFields (document) –
        
        If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
        
        For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
    - 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. For more information, see Parser Lambda function in Amazon Bedrock Agents.
  - guardrailConfiguration (dict) –
    
    Details about the guardrail associated with the agent.
    - guardrailIdentifier (string) –
      
      The unique identifier of the guardrail.
    - guardrailVersion (string) –
      
      The version of the guardrail.
  - memoryConfiguration (dict) –
    
    Contains details of the memory configuration on the version of the agent.
    - enabledMemoryTypes (list) –
      
      The type of memory that is stored.
      - (string) –
    - storageDays (integer) –
      
      The number of days the agent is configured to retain the conversational context.
    - sessionSummaryConfiguration (dict) –
      
      Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
      - maxRecentSessions (integer) –
        
        Maximum number of recent session summaries to include in the agent’s prompt context.
  - agentCollaboration (string) –
    
    The agent’s collaboration settings.

Exceptions

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