Struct google_api_proto::google::ai::generativelanguage::v1beta::QueryDocumentRequest

pub struct QueryDocumentRequest {
    pub name: String,
    pub query: String,
    pub results_count: i32,
    pub metadata_filters: Vec<MetadataFilter>,
}

Request for querying a Document.

Fields

name: String

Required. The name of the Document to query. Example: corpora/my-corpus-123/documents/the-doc-abc

query: String

Required. Query string to perform semantic search.

results_count: i32

Optional. The maximum number of Chunks to return. The service may return fewer Chunks.

If unspecified, at most 10 Chunks will be returned. The maximum specified result count is 100.

metadata_filters: Vec<MetadataFilter>

Optional. Filter for Chunk metadata. Each MetadataFilter object should correspond to a unique key. Multiple MetadataFilter objects are joined by logical “AND“s.

Note: Document-level filtering is not supported for this request because a Document name is already specified.

Example query: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadata_filters = [ {key = “chunk.custom_metadata.year” conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = “chunk.custom_metadata.genre” conditions = [{string_value = “drama”, operation = EQUAL}, {string_value = “action”, operation = EQUAL}}]

Example query for a numeric range of values: (year > 2015 AND year <= 2020)

MetadataFilter object list: metadata_filters = [ {key = “chunk.custom_metadata.year” conditions = [{int_value = 2015, operation = GREATER}]}, {key = “chunk.custom_metadata.year” conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Note: “AND“s for the same key are only supported for numeric values. String values only support “OR“s for the same key.

Trait Implementations

impl Clone for QueryDocumentRequest

fn clone(&self) -> QueryDocumentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryDocumentRequest

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

Formats the value using the given formatter.

impl Default for QueryDocumentRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for QueryDocumentRequest

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 QueryDocumentRequest

fn eq(&self, other: &QueryDocumentRequest) -> 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 QueryDocumentRequest