SourceAttribution (p.awso.0.9.1.doc.awso.qbusiness.Awso

Sourcetype nonrec t = {

title : String_.t option;
(*
The title of the document which is the source for the Amazon Q Business generated response.
*)
snippet : String_.t option;
(*
The content extract from the document on which the generated response is based.
*)
url : String_.t option;
(*
The URL of the document which is the source for the Amazon Q Business generated response.
*)
citationNumber : Integer.t option;
(*
The number attached to a citation in an Amazon Q Business generated response.
*)
updatedAt : Timestamp.t option;
(*
The Unix timestamp when the Amazon Q Business application was last updated.
*)
textMessageSegments : TextSegmentList.t option;
(*
A text extract from a source document that is used for source attribution.
*)
documentId : String_.t option;
(*
The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification.
*)
indexId : String_.t option;
(*
The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.
*)
datasourceId : String_.t option;
(*
The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".
*)

}

val make : 
  ?title:??? ->
  ?snippet:??? ->
  ?url:??? ->
  ?citationNumber:??? ->
  ?updatedAt:??? ->
  ?textMessageSegments:??? ->
  ?documentId:??? ->
  ?indexId:??? ->
  ?datasourceId:??? ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Integer of Integer.t
          | `List of
            [> `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 ]
              list
          | `String of String_.t
          | `Timestamp of Timestamp.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