Module Values.GetDocumentContentRequestSource

Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.

Sourcetype nonrec t = {
  1. applicationId : ApplicationId.t;
    (*

    The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

    *)
  2. indexId : IndexId.t;
    (*

    The identifier of the index where documents are indexed.

    *)
  3. dataSourceId : DataSourceId.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. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".

    *)
  4. documentId : DocumentId.t;
    (*

    The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

    *)
  5. outputFormat : OutputFormat.t option;
    (*

    Document outputFormat. Defaults to RAW if not selected.

    *)
}
Sourceval context_ : string
Sourceval make : ?dataSourceId:??? -> ?outputFormat:??? -> applicationId:ApplicationId.t -> indexId:IndexId.t -> documentId:DocumentId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of ApplicationId.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