Module Values.RetrieveResultItemSource

A single retrieved relevant passage result.

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

    The identifier of the relevant passage result.

    *)
  2. documentId : DocumentId.t option;
    (*

    The identifier of the document.

    *)
  3. documentTitle : DocumentTitle.t option;
    (*

    The title of the document.

    *)
  4. content : Content.t option;
    (*

    The contents of the relevant passage.

    *)
  5. documentURI : Url.t option;
    (*

    The URI of the original location of the document.

    *)
  6. documentAttributes : DocumentAttributeList.t option;
    (*

    An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

    *)
  7. scoreAttributes : ScoreAttributes.t option;
    (*

    The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

    *)
}
Sourceval make : ?id:??? -> ?documentId:??? -> ?documentTitle:??? -> ?content:??? -> ?documentURI:??? -> ?documentAttributes:??? -> ?scoreAttributes:??? -> unit -> t
Sourceval to_value : t -> [> `Structure 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 DocumentAttributeStringValue.t | `Timestamp of Timestamp.t ]) list ]) list ] list | `String of ResultId.t | `Structure of (string * [> `Enum of string ]) 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