Module Values.FeaturedDocumentWithMetadataSource

A featured document with its metadata information. This document 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 the document is featured in the search results.

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

    The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

    *)
  2. title : String_.t option;
    (*

    The main title of the featured document.

    *)
  3. uRI : Url.t option;
    (*

    The source URI location of the featured document.

    *)
}
Sourceval make : ?id:??? -> ?title:??? -> ?uRI:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of DocumentId.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