Struct FindNeighborsRequest

#[non_exhaustive]
pub struct FindNeighborsRequest {
    pub index_endpoint: String,
    pub deployed_index_id: String,
    pub queries: Vec<Query>,
    pub return_full_datapoint: bool,
    /* private fields */
}

The request message for MatchService.FindNeighbors.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_endpoint: String

Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployed_index_id: String

The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.

queries: Vec<Query>

The list of queries.

return_full_datapoint: bool

If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query.

Implementations

impl FindNeighborsRequest

pub fn new() -> Self

pub fn set_index_endpoint<T: Into<String>>(self, v: T) -> Self

Sets the value of index_endpoint.

pub fn set_deployed_index_id<T: Into<String>>(self, v: T) -> Self

Sets the value of deployed_index_id.

pub fn set_queries<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Query>,

Sets the value of queries.

pub fn set_return_full_datapoint<T: Into<bool>>(self, v: T) -> Self

Sets the value of return_full_datapoint.

Trait Implementations

impl Clone for FindNeighborsRequest

fn clone(&self) -> FindNeighborsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindNeighborsRequest

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

Formats the value using the given formatter.

impl Default for FindNeighborsRequest

fn default() -> FindNeighborsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindNeighborsRequest

where FindNeighborsRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FindNeighborsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FindNeighborsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FindNeighborsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FindNeighborsRequest