Module Values.DocumentSource

A document in an Amazon Q Business application.

Sourcetype nonrec t = {
  1. id : DocumentId.t;
    (*

    The identifier of the document.

    *)
  2. attributes : DocumentAttributes.t option;
    (*

    Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

    *)
  3. content : DocumentContent.t option;
    (*

    The contents of the document.

    *)
  4. contentType : ContentType.t option;
    (*

    The file type of the document in the Blob field. If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

    *)
  5. title : Title.t option;
    (*

    The title of the document.

    *)
  6. accessConfiguration : AccessConfiguration.t option;
    (*

    Configuration information for access permission to a document.

    *)
  7. documentEnrichmentConfiguration : DocumentEnrichmentConfiguration.t option;
    (*

    The configuration information for altering document metadata and content during the document ingestion process.

    *)
  8. mediaExtractionConfiguration : MediaExtractionConfiguration.t option;
    (*

    The configuration for extracting information from media in the document.

    *)
}
Sourceval context_ : string
Sourceval make : ?attributes:??? -> ?content:??? -> ?contentType:??? -> ?title:??? -> ?accessConfiguration:??? -> ?documentEnrichmentConfiguration:??? -> ?mediaExtractionConfiguration:??? -> id:DocumentId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeValueStringValueString.t | `Timestamp of Timestamp.t ]) list ]) list ] list | `String of DocumentId.t | `Structure of (string * [> `Blob of Blob.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of UserId.t ]) list ]) list ] list | `Structure of (string * [> `Enum of string | `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeValueStringValueString.t | `Timestamp of Timestamp.t ]) list ]) list ]) list ] list | `Structure of (string * [> `Enum of string | `String of S3BucketName.t | `Structure of (string * [> `Enum of string | `String of DocumentAttributeKey.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeValueStringValueString.t | `Timestamp of Timestamp.t ]) list ]) list ]) 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