Module Values.TextSegmentSource

Provides information about a text extract in a chat response that can be attributed to a source document.

Sourcetype nonrec t = {
  1. beginOffset : Integer.t option;
    (*

    The zero-based location in the response string where the source attribution starts.

    *)
  2. endOffset : Integer.t option;
    (*

    The zero-based location in the response string where the source attribution ends.

    *)
  3. snippetExcerpt : SnippetExcerpt.t option;
    (*

    The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

    *)
  4. mediaId : SourceAttributionMediaId.t option;
    (*

    The identifier of the media object associated with the text segment in the source attribution.

    *)
  5. mediaMimeType : String_.t option;
    (*

    The MIME type (image/png) of the media object associated with the text segment in the source attribution.

    *)
  6. sourceDetails : SourceDetails.t option;
    (*

    Source information for a segment of extracted text, including its media type.

    *)
}
Sourceval make : ?beginOffset:??? -> ?endOffset:??? -> ?snippetExcerpt:??? -> ?mediaId:??? -> ?mediaMimeType:??? -> ?sourceDetails:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Integer.t | `String of SourceAttributionMediaId.t | `Structure of (string * [> `String of SnippetExcerptText.t | `Structure of (string * [> `Enum of string | `Long of Long.t | `String of MediaId.t ]) list ]) 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