Agent (p.awso.0.9.1.doc.awso.bedrock-agent.Awso_bedrock

Sourcetype nonrec t = {

agentId : Id.t option;
(*
The unique identifier of the agent.
*)
agentName : Name.t option;
(*
The name of the agent.
*)
agentArn : AgentArn.t option;
(*
The Amazon Resource Name (ARN) of the agent.
*)
agentVersion : DraftVersion.t option;
(*
The version of the agent.
*)
clientToken : ClientToken.t option;
(*
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.
*)
instruction : Instruction.t option;
(*
Instructions that tell the agent what it should do and how it should interact with users.
*)
agentStatus : AgentStatus.t option;
(*
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.
*)
foundationModel : ModelIdentifier.t option;
(*
The foundation model used for orchestration by the agent.
*)
description : Description.t option;
(*
The description of the agent.
*)
orchestrationType : OrchestrationType.t option;
(*
Specifies the orchestration strategy for the agent.
*)
customOrchestration : CustomOrchestration.t option;
(*
Contains custom orchestration configurations for the agent.
*)
idleSessionTTLInSeconds : SessionTTL.t option;
(*
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 : AgentRoleArn.t option;
(*
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
*)
customerEncryptionKeyArn : KmsKeyArn.t option;
(*
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
*)
createdAt : DateTimestamp.t option;
(*
The time at which the agent was created.
*)
updatedAt : DateTimestamp.t option;
(*
The time at which the agent was last updated.
*)
preparedAt : DateTimestamp.t option;
(*
The time at which the agent was last prepared.
*)
failureReasons : FailureReasons.t option;
(*
Contains reasons that the agent-related API that you invoked failed.
*)
recommendedActions : RecommendedActions.t option;
(*
Contains recommended actions to take for the agent-related API that you invoked to succeed.
*)
promptOverrideConfiguration : PromptOverrideConfiguration.t option;
(*
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
*)
guardrailConfiguration : GuardrailConfiguration.t option;
(*
Details about the guardrail associated with the agent.
*)
memoryConfiguration : MemoryConfiguration.t option;
(*
Contains memory configuration for the agent.
*)
agentCollaboration : AgentCollaboration.t option;
(*
The agent's collaboration settings.
*)

}

val make : 
  ?agentId:??? ->
  ?agentName:??? ->
  ?agentArn:??? ->
  ?agentVersion:??? ->
  ?clientToken:??? ->
  ?instruction:??? ->
  ?agentStatus:??? ->
  ?foundationModel:??? ->
  ?description:??? ->
  ?orchestrationType:??? ->
  ?customOrchestration:??? ->
  ?idleSessionTTLInSeconds:??? ->
  ?agentResourceRoleArn:??? ->
  ?customerEncryptionKeyArn:??? ->
  ?createdAt:??? ->
  ?updatedAt:??? ->
  ?preparedAt:??? ->
  ?failureReasons:??? ->
  ?recommendedActions:??? ->
  ?promptOverrideConfiguration:??? ->
  ?guardrailConfiguration:??? ->
  ?memoryConfiguration:??? ->
  ?agentCollaboration:??? ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `Integer of SessionTTL.t
          | `List of [> `String of FailureReason.t ] list
          | `String of Id.t
          | `Structure of
            (string
             * [> `Integer of StorageDays.t
               | `List of
                 [> `Enum of string
                 | `Structure of
                   (string
                    * [> `Enum of string
                      | `String of BasePromptTemplate.t
                      | `Structure of
                        (string
                         * [> `Float of Temperature.t
                           | `Integer of TopK.t
                           | `List of [> `String of String_.t ] list ])
                          list ])
                     list ]
                   list
               | `String of LambdaArn.t
               | `Structure of
                 (string
                  * [> `Integer of MaxRecentSessions.t
                    | `String of LambdaArn.t ])
                   list ])
              list
          | `Timestamp of DateTimestamp.t ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t