Show / Hide Table of Contents

Class GoogleCloudAiplatformV1beta1FindNeighborsRequest

The request message for MatchService.FindNeighbors.

Inheritance
object
GoogleCloudAiplatformV1beta1FindNeighborsRequest
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1beta1.Data
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class GoogleCloudAiplatformV1beta1FindNeighborsRequest : IDirectResponseSchema

Properties

DeployedIndexId

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.

Declaration
[JsonProperty("deployedIndexId")]
public virtual string DeployedIndexId { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Queries

The list of queries.

Declaration
[JsonProperty("queries")]
public virtual IList<GoogleCloudAiplatformV1beta1FindNeighborsRequestQuery> Queries { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1beta1FindNeighborsRequestQuery>

ReturnFullDatapoint

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.

Declaration
[JsonProperty("returnFullDatapoint")]
public virtual bool? ReturnFullDatapoint { get; set; }
Property Value
Type Description
bool?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX