public sealed class FindNeighborsRequest : IMessage<FindNeighborsRequest>, IEquatable<FindNeighborsRequest>, IDeepCloneable<FindNeighborsRequest>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class FindNeighborsRequest.
The request message for [MatchService.FindNeighbors][google.cloud.aiplatform.v1beta1.MatchService.FindNeighbors].
Implements
IMessageFindNeighborsRequest, IEquatableFindNeighborsRequest, IDeepCloneableFindNeighborsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
FindNeighborsRequest()
public FindNeighborsRequest()FindNeighborsRequest(FindNeighborsRequest)
public FindNeighborsRequest(FindNeighborsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
FindNeighborsRequest |
Properties
DeployedIndexId
public string DeployedIndexId { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
IndexEndpoint
public string IndexEndpoint { get; set; }Required. The name of the index endpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
| Property Value | |
|---|---|
| Type | Description |
string |
|
IndexEndpointAsIndexEndpointName
public IndexEndpointName IndexEndpointAsIndexEndpointName { get; set; }IndexEndpointName-typed view over the IndexEndpoint resource name property.
| Property Value | |
|---|---|
| Type | Description |
IndexEndpointName |
|
Queries
public RepeatedField<FindNeighborsRequest.Types.Query> Queries { get; }The list of queries.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldFindNeighborsRequestTypesQuery |
|
ReturnFullDatapoint
public bool ReturnFullDatapoint { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|