Up – Package index » awso » Library awso.bedrock-agent » Awso_bedrock_agent » Values » ParameterDetail

Module `Values.ParameterDetail`Source

Contains details about a parameter in a function for an action group. This data type is used in the following API operations: CreateAgentActionGroup request CreateAgentActionGroup response UpdateAgentActionGroup request UpdateAgentActionGroup response GetAgentActionGroup response

Sourcetype nonrec t = {

description : ParameterDescription.t option;
(*
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
*)
type_ : Type.t;
(*
The data type of the parameter.
*)
required : Boolean.t option;
(*
Whether the parameter is required for the agent to complete the function for action group invocation.
*)

}

Sourceval context_ : string

Sourceval make : ?description:??? -> ?required:??? -> type_:Type.t -> unit -> t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Boolean of Boolean.t
          | `Enum of string
          | `String of ParameterDescription.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