/AWS1/IF_BDA=>CREATEAGENT()

About CreateAgent

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

• Specify the following fields for security purposes.

  • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

  • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

  • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

• To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.

• To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

• If your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

• The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Method Signature

METHODS /AWS1/IF_BDA~CREATEAGENT
  IMPORTING
    !IV_AGENTNAME TYPE /AWS1/BDANAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/BDACLIENTTOKEN OPTIONAL
    !IV_INSTRUCTION TYPE /AWS1/BDAINSTRUCTION OPTIONAL
    !IV_FOUNDATIONMODEL TYPE /AWS1/BDAMODELIDENTIFIER OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/BDADESCRIPTION OPTIONAL
    !IV_ORCHESTRATIONTYPE TYPE /AWS1/BDAORCHESTRATIONTYPE OPTIONAL
    !IO_CUSTOMORCHESTRATION TYPE REF TO /AWS1/CL_BDACUSTORCHESTRATION OPTIONAL
    !IV_IDLESESSIONTTLINSECONDS TYPE /AWS1/BDASESSIONTTL OPTIONAL
    !IV_AGENTRESOURCEROLEARN TYPE /AWS1/BDAAGENTROLEARN OPTIONAL
    !IV_CUSTOMERENCRYPTIONKEYARN TYPE /AWS1/BDAKMSKEYARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_BDATAGSMAP_W=>TT_TAGSMAP OPTIONAL
    !IO_PROMPTOVERRIDECONF TYPE REF TO /AWS1/CL_BDAPROMPTOVERRIDECONF OPTIONAL
    !IO_GUARDRAILCONFIGURATION TYPE REF TO /AWS1/CL_BDAGUARDRAILCONF OPTIONAL
    !IO_MEMORYCONFIGURATION TYPE REF TO /AWS1/CL_BDAMEMORYCONF OPTIONAL
    !IV_AGENTCOLLABORATION TYPE /AWS1/BDAAGENTCOLLABORATION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdacreateagentrsp
  RAISING
    /AWS1/CX_BDAACCESSDENIEDEX
    /AWS1/CX_BDACONFLICTEXCEPTION
    /AWS1/CX_BDAINTERNALSERVEREX
    /AWS1/CX_BDASERVICEQUOTAEXCDEX
    /AWS1/CX_BDATHROTTLINGEX
    /AWS1/CX_BDAVALIDATIONEX
    /AWS1/CX_BDACLIENTEXC
    /AWS1/CX_BDASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentname TYPE /AWS1/BDANAME /AWS1/BDANAME

A name for the agent that you create.

Optional arguments:

iv_clienttoken TYPE /AWS1/BDACLIENTTOKEN /AWS1/BDACLIENTTOKEN

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.

iv_instruction TYPE /AWS1/BDAINSTRUCTION /AWS1/BDAINSTRUCTION

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

iv_foundationmodel TYPE /AWS1/BDAMODELIDENTIFIER /AWS1/BDAMODELIDENTIFIER

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

iv_description TYPE /AWS1/BDADESCRIPTION /AWS1/BDADESCRIPTION

A description of the agent.

iv_orchestrationtype TYPE /AWS1/BDAORCHESTRATIONTYPE /AWS1/BDAORCHESTRATIONTYPE

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

io_customorchestration TYPE REF TO /AWS1/CL_BDACUSTORCHESTRATION /AWS1/CL_BDACUSTORCHESTRATION

Contains details of the custom orchestration configured for the agent.

iv_idlesessionttlinseconds TYPE /AWS1/BDASESSIONTTL /AWS1/BDASESSIONTTL

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.

iv_agentresourcerolearn TYPE /AWS1/BDAAGENTROLEARN /AWS1/BDAAGENTROLEARN

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

iv_customerencryptionkeyarn TYPE /AWS1/BDAKMSKEYARN /AWS1/BDAKMSKEYARN

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

it_tags TYPE /AWS1/CL_BDATAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

Any tags that you want to attach to the agent.

io_promptoverrideconf TYPE REF TO /AWS1/CL_BDAPROMPTOVERRIDECONF /AWS1/CL_BDAPROMPTOVERRIDECONF

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

io_guardrailconfiguration TYPE REF TO /AWS1/CL_BDAGUARDRAILCONF /AWS1/CL_BDAGUARDRAILCONF

The unique Guardrail configuration assigned to the agent when it is created.

io_memoryconfiguration TYPE REF TO /AWS1/CL_BDAMEMORYCONF /AWS1/CL_BDAMEMORYCONF

Contains the details of the memory configured for the agent.

iv_agentcollaboration TYPE /AWS1/BDAAGENTCOLLABORATION /AWS1/BDAAGENTCOLLABORATION

The agent's collaboration role.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdacreateagentrsp /AWS1/CL_BDACREATEAGENTRSP

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createagent(
  io_customorchestration = new /aws1/cl_bdacustorchestration( new /aws1/cl_bdaorchestrationexe00( |string| ) )
  io_guardrailconfiguration = new /aws1/cl_bdaguardrailconf(
    iv_guardrailidentifier = |string|
    iv_guardrailversion = |string|
  )
  io_memoryconfiguration = new /aws1/cl_bdamemoryconf(
    io_sessionsummaryconf = new /aws1/cl_bdasessionsummaryconf( 123 )
    it_enabledmemorytypes = VALUE /aws1/cl_bdaenbdmemorytypes_w=>tt_enabledmemorytypes(
      ( new /aws1/cl_bdaenbdmemorytypes_w( |string| ) )
    )
    iv_storagedays = 123
  )
  io_promptoverrideconf = new /aws1/cl_bdapromptoverrideconf(
    it_promptconfigurations = VALUE /aws1/cl_bdapromptconf=>tt_promptconfigurations(
      (
        new /aws1/cl_bdapromptconf(
          io_addlmodelrequestfields = /AWS1/CL_RT_DOCUMENT=>FROM_JSON_STR( |\{"foo":"this is a JSON object..."\}| )
          io_inferenceconfiguration = new /aws1/cl_bdainferenceconf(
            it_stopsequences = VALUE /aws1/cl_bdastopsequences_w=>tt_stopsequences(
              ( new /aws1/cl_bdastopsequences_w( |string| ) )
            )
            iv_maximumlength = 123
            iv_temperature = '0.1'
            iv_topk = 123
            iv_topp = '0.1'
          )
          iv_baseprompttemplate = |string|
          iv_foundationmodel = |string|
          iv_parsermode = |string|
          iv_promptcreationmode = |string|
          iv_promptstate = |string|
          iv_prompttype = |string|
        )
      )
    )
    iv_overridelambda = |string|
  )
  it_tags = VALUE /aws1/cl_bdatagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_bdatagsmap_w=>ts_tagsmap_maprow(
        value = new /aws1/cl_bdatagsmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_agentcollaboration = |string|
  iv_agentname = |string|
  iv_agentresourcerolearn = |string|
  iv_clienttoken = |string|
  iv_customerencryptionkeyarn = |string|
  iv_description = |string|
  iv_foundationmodel = |string|
  iv_idlesessionttlinseconds = 123
  iv_instruction = |string|
  iv_orchestrationtype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_agent = lo_result->get_agent( ).
  IF lo_agent IS NOT INITIAL.
    lv_id = lo_agent->get_agentid( ).
    lv_name = lo_agent->get_agentname( ).
    lv_agentarn = lo_agent->get_agentarn( ).
    lv_draftversion = lo_agent->get_agentversion( ).
    lv_clienttoken = lo_agent->get_clienttoken( ).
    lv_instruction = lo_agent->get_instruction( ).
    lv_agentstatus = lo_agent->get_agentstatus( ).
    lv_modelidentifier = lo_agent->get_foundationmodel( ).
    lv_description = lo_agent->get_description( ).
    lv_orchestrationtype = lo_agent->get_orchestrationtype( ).
    lo_customorchestration = lo_agent->get_customorchestration( ).
    IF lo_customorchestration IS NOT INITIAL.
      lo_orchestrationexecutor = lo_customorchestration->get_executor( ).
      IF lo_orchestrationexecutor IS NOT INITIAL.
        lv_lambdaarn = lo_orchestrationexecutor->get_lambda( ).
      ENDIF.
    ENDIF.
    lv_sessionttl = lo_agent->get_idlesessionttlinseconds( ).
    lv_agentrolearn = lo_agent->get_agentresourcerolearn( ).
    lv_kmskeyarn = lo_agent->get_customerencryptionkeyarn( ).
    lv_datetimestamp = lo_agent->get_createdat( ).
    lv_datetimestamp = lo_agent->get_updatedat( ).
    lv_datetimestamp = lo_agent->get_preparedat( ).
    LOOP AT lo_agent->get_failurereasons( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_failurereason = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_agent->get_recommendedactions( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_recommendedaction = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lo_promptoverrideconfigura = lo_agent->get_promptoverrideconf( ).
    IF lo_promptoverrideconfigura IS NOT INITIAL.
      LOOP AT lo_promptoverrideconfigura->get_promptconfigurations( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_prompttype = lo_row_5->get_prompttype( ).
          lv_creationmode = lo_row_5->get_promptcreationmode( ).
          lv_promptstate = lo_row_5->get_promptstate( ).
          lv_baseprompttemplate = lo_row_5->get_baseprompttemplate( ).
          lo_inferenceconfiguration = lo_row_5->get_inferenceconfiguration( ).
          IF lo_inferenceconfiguration IS NOT INITIAL.
            lv_temperature = lo_inferenceconfiguration->get_temperature( ).
            lv_topp = lo_inferenceconfiguration->get_topp( ).
            lv_topk = lo_inferenceconfiguration->get_topk( ).
            lv_maximumlength = lo_inferenceconfiguration->get_maximumlength( ).
            LOOP AT lo_inferenceconfiguration->get_stopsequences( ) into lo_row_6.
              lo_row_7 = lo_row_6.
              IF lo_row_7 IS NOT INITIAL.
                lv_string = lo_row_7->get_value( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
          lv_creationmode = lo_row_5->get_parsermode( ).
          lv_modelidentifier = lo_row_5->get_foundationmodel( ).
          lo_value = lo_row_5->get_addlmodelrequestfields( ).
          IF lo_value IS NOT INITIAL.
          ENDIF.
        ENDIF.
      ENDLOOP.
      lv_lambdaarn = lo_promptoverrideconfigura->get_overridelambda( ).
    ENDIF.
    lo_guardrailconfiguration = lo_agent->get_guardrailconfiguration( ).
    IF lo_guardrailconfiguration IS NOT INITIAL.
      lv_guardrailidentifier = lo_guardrailconfiguration->get_guardrailidentifier( ).
      lv_guardrailversion = lo_guardrailconfiguration->get_guardrailversion( ).
    ENDIF.
    lo_memoryconfiguration = lo_agent->get_memoryconfiguration( ).
    IF lo_memoryconfiguration IS NOT INITIAL.
      LOOP AT lo_memoryconfiguration->get_enabledmemorytypes( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_memorytype = lo_row_9->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_storagedays = lo_memoryconfiguration->get_storagedays( ).
      lo_sessionsummaryconfigura = lo_memoryconfiguration->get_sessionsummaryconf( ).
      IF lo_sessionsummaryconfigura IS NOT INITIAL.
        lv_maxrecentsessions = lo_sessionsummaryconfigura->get_maxrecentsessions( ).
      ENDIF.
    ENDIF.
    lv_agentcollaboration = lo_agent->get_agentcollaboration( ).
  ENDIF.
ENDIF.