AgentsforBedrock / Client / get_agent

get_agent#

AgentsforBedrock.Client.get_agent(**kwargs)#

Gets information about an agent.

See also: AWS API Documentation

Request Syntax

response = client.get_agent(
    agentId='string'
)
Parameters:

agentId (string) –

[REQUIRED]

The unique identifier of the agent.

Return type:

dict

Returns:

Response Syntax

{
    'agent': {
        'agentArn': 'string',
        'agentCollaboration': 'SUPERVISOR'|'SUPERVISOR_ROUTER'|'DISABLED',
        'agentId': 'string',
        'agentName': 'string',
        'agentResourceRoleArn': 'string',
        'agentStatus': 'CREATING'|'PREPARING'|'PREPARED'|'NOT_PREPARED'|'DELETING'|'FAILED'|'VERSIONING'|'UPDATING',
        'agentVersion': 'string',
        'clientToken': 'string',
        'createdAt': datetime(2015, 1, 1),
        'customOrchestration': {
            'executor': {
                'lambda': 'string'
            }
        },
        'customerEncryptionKeyArn': 'string',
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'foundationModel': 'string',
        'guardrailConfiguration': {
            'guardrailIdentifier': 'string',
            'guardrailVersion': 'string'
        },
        'idleSessionTTLInSeconds': 123,
        'instruction': 'string',
        'memoryConfiguration': {
            'enabledMemoryTypes': [
                'SESSION_SUMMARY',
            ],
            'sessionSummaryConfiguration': {
                'maxRecentSessions': 123
            },
            'storageDays': 123
        },
        'orchestrationType': 'DEFAULT'|'CUSTOM_ORCHESTRATION',
        'preparedAt': datetime(2015, 1, 1),
        'promptOverrideConfiguration': {
            'overrideLambda': 'string',
            'promptConfigurations': [
                {
                    'basePromptTemplate': 'string',
                    'foundationModel': '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'|'MEMORY_SUMMARIZATION'
                },
            ]
        },
        'recommendedActions': [
            'string',
        ],
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • agent (dict) –

      Contains details about the agent.

      • agentArn (string) –

        The Amazon Resource Name (ARN) of the agent.

      • agentCollaboration (string) –

        The agent’s collaboration settings.

      • agentId (string) –

        The unique identifier of the agent.

      • agentName (string) –

        The name of the agent.

      • 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 and whether it is ready for use. The following statuses are possible:

        • CREATING – The agent is being created.

        • PREPARING – The agent is being prepared.

        • PREPARED – The agent is prepared and ready to be invoked.

        • NOT_PREPARED – The agent has been created but not yet prepared.

        • FAILED – The agent API operation failed.

        • UPDATING – The agent is being updated.

        • DELETING – The agent is being deleted.

      • agentVersion (string) –

        The version of the agent.

      • 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.

      • createdAt (datetime) –

        The time at which the agent was created.

      • customOrchestration (dict) –

        Contains custom orchestration configurations for the agent.

        • executor (dict) –

          The structure of the executor invoking the actions in custom orchestration.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: lambda. 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'}

          • lambda (string) –

            The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

      • customerEncryptionKeyArn (string) –

        The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

      • description (string) –

        The description of the agent.

      • failureReasons (list) –

        Contains reasons that the agent-related API that you invoked failed.

        • (string) –

      • foundationModel (string) –

        The foundation model used for orchestration by the agent.

      • 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.

      • 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) –

        Instructions that tell the agent what it should do and how it should interact with users.

      • memoryConfiguration (dict) –

        Contains memory configuration for the agent.

        • enabledMemoryTypes (list) –

          The type of memory that is stored.

          • (string) –

        • 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.

        • storageDays (integer) –

          The number of days the agent is configured to retain the conversational context.

      • orchestrationType (string) –

        Specifies the orchestration strategy for the agent.

      • preparedAt (datetime) –

        The time at which the agent was last prepared.

      • 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. For more information, see Parser Lambda function in Amazon Bedrock Agents.

        • 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. For more information, see Configure the prompt templates.

            • foundationModel (string) –

              The agent’s foundation model.

            • 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) –

        Contains recommended actions to take for the agent-related API that you invoked to succeed.

        • (string) –

      • updatedAt (datetime) –

        The time at which the agent was last updated.

Exceptions