Values.QueryResultItemSourceA single query result. A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
type nonrec t = {id : ResultId.t option;The unique identifier for the query result item id (Id) and the query result item document id (DocumentId) combined. The value of this field changes with every request, even when you have the same documents.
*)type_ : QueryResultType.t option;The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
*)format : QueryResultFormat.t option;If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
*)additionalAttributes : AdditionalResultAttributeList.t option;One or more additional fields/attributes associated with the query result.
*)documentId : DocumentId.t option;The identifier for the document.
*)documentTitle : TextWithHighlights.t option;The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
*)documentExcerpt : TextWithHighlights.t option;An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
*)documentURI : Url.t option;The URI of the original location of the document.
*)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.
*)scoreAttributes : ScoreAttributes.t option;Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application. The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result is relevant to the query.
*)feedbackToken : FeedbackToken.t option;A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
*)tableExcerpt : TableExcerpt.t option;An excerpt from a table within a document.
*)collapsedResultDetail : CollapsedResultDetail.t option;Provides details about a collapsed group of search results.
*)}val make :
?id:??? ->
?type_:??? ->
?format:??? ->
?additionalAttributes:??? ->
?documentId:??? ->
?documentTitle:??? ->
?documentExcerpt:??? ->
?documentURI:??? ->
?documentAttributes:??? ->
?scoreAttributes:??? ->
?feedbackToken:??? ->
?tableExcerpt:??? ->
?collapsedResultDetail:??? ->
unit ->
tval 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
* [> `Enum of string
| `Integer of Integer.t
| `List of
[> `Structure of
(string
* [> `Boolean of Boolean.t
| `Enum of string
| `Integer of Integer.t
| `List of
[> `Structure of
(string
* [> `Boolean of Boolean.t
| `String of String_.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
* [> `List of
[> `Structure of
(string
* [> `Boolean of Boolean.t
| `Enum of string
| `Integer of Integer.t ])
list ]
list
| `String of String_.t ])
list ])
list ]
list
| `String of String_.t
| `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 ])
list ]