Module Values.FeaturedResultsItemSource

A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

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

    The identifier of the featured result.

    *)
  2. type_ : QueryResultType.t option;
    (*

    The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

    *)
  3. additionalAttributes : AdditionalResultAttributeList.t option;
    (*

    One or more additional attributes associated with the featured result.

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

    The identifier of the featured document.

    *)
  5. documentTitle : TextWithHighlights.t option;
  6. documentExcerpt : TextWithHighlights.t option;
  7. documentURI : Url.t option;
    (*

    The source URI location of the featured document.

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

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

    *)
  9. feedbackToken : FeedbackToken.t option;
    (*

    A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

    *)
}
Sourceval make : ?id:??? -> ?type_:??? -> ?additionalAttributes:??? -> ?documentId:??? -> ?documentTitle:??? -> ?documentExcerpt:??? -> ?documentURI:??? -> ?documentAttributes:??? -> ?feedbackToken:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `List of [> `String of String_.t ] list | `Long of Long.t | `String of DocumentAttributeStringValue.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t ]) list ] list | `String of String_.t ]) list | `Timestamp of Timestamp.t ]) list ]) list ] list | `String of ResultId.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of Integer.t ]) list ] list | `String of String_.t ]) 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