Struct google_api_proto::google::cloud::contentwarehouse::v1::search_documents_response::MatchingDocument

pub struct MatchingDocument {
    pub document: Option<Document>,
    pub search_text_snippet: String,
    pub qa_result: Option<QaResult>,
    pub matched_token_page_indices: Vec<i64>,
}

Document entry with metadata inside [SearchDocumentsResponse][google.cloud.contentwarehouse.v1.SearchDocumentsResponse]

Fields

document: Option<Document>

Document that matches the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest]. This document only contains indexed metadata information.

search_text_snippet: String

Contains snippets of text from the document full raw text that most closely match a search query’s keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.

If the question-answering feature is enabled, this field will instead contain a snippet that answers the user’s natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in [QAResult.highlights][google.cloud.contentwarehouse.v1.QAResult.highlights].

qa_result: Option<QaResult>

Experimental. Additional result info if the question-answering feature is enabled.

matched_token_page_indices: Vec<i64>

Return the 1-based page indices where those pages have one or more matched tokens.

Trait Implementations

impl Clone for MatchingDocument

fn clone(&self) -> MatchingDocument

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatchingDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MatchingDocument

fn default() -> Self

Returns the “default value” for a type.

impl Message for MatchingDocument

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for MatchingDocument

fn eq(&self, other: &MatchingDocument) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MatchingDocument