Module Values.GetHumanReadableSummaryResponseSource

Retrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request This method uses a Large Language Model (LLM) to generate the summary. If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieve a summary of that request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, read default permissions granted to delegation requests. These rules are identical to GetDelegationRequest API behavior, such that a party who has permissions to call GetDelegationRequest for a given delegation request will always be able to retrieve the human readable summary for that request.

Sourcetype getHumanReadableSummaryResult = {
  1. summaryContent : SummaryContentType.t option;
    (*

    Summary content in the specified locale. Summary content is non-empty only if the SummaryState is AVAILABLE.

    *)
  2. locale : LocaleType.t option;
    (*

    The locale that this response was generated for. This maps to the input locale.

    *)
  3. summaryState : SummaryStateType.t option;
    (*

    State of summary generation. This generation process is asynchronous and this attribute indicates the state of the generation process.

    *)
}
Sourceand responseMetaData = unit
Sourceand t = {
  1. getHumanReadableSummaryResult : getHumanReadableSummaryResult;
  2. responseMetaData : responseMetaData;
}
Sourcetype error = [
  1. | `InvalidInputException of InvalidInputException.t
  2. | `NoSuchEntityException of NoSuchEntityException.t
  3. | `ServiceFailureException of ServiceFailureException.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval context_ : string
Sourceval make : ?summaryContent:??? -> ?locale:??? -> ?summaryState:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InvalidInputException of InvalidInputException.t | `NoSuchEntityException of NoSuchEntityException.t | `ServiceFailureException of ServiceFailureException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InvalidInputException of InvalidInputException.t | `NoSuchEntityException of NoSuchEntityException.t | `ServiceFailureException of ServiceFailureException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of SummaryContentType.t ]) list ]) 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