Generated from protobuf message google.cloud.aiplatform.v1.FindNeighborsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ 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.
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.
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.
Returns
Type
Description
string
setDeployedIndexId
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class FindNeighborsRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.FindNeighborsRequest)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.FindNeighborsRequest)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.FindNeighborsRequest)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.FindNeighborsRequest)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.FindNeighborsRequest)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.FindNeighborsRequest)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.FindNeighborsRequest)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.FindNeighborsRequest)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.FindNeighborsRequest)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.FindNeighborsRequest)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.FindNeighborsRequest)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.FindNeighborsRequest)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.FindNeighborsRequest)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.FindNeighborsRequest)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.FindNeighborsRequest)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.FindNeighborsRequest)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.FindNeighborsRequest)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.FindNeighborsRequest)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.FindNeighborsRequest)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.FindNeighborsRequest)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.FindNeighborsRequest)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.FindNeighborsRequest)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.FindNeighborsRequest)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.FindNeighborsRequest)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.FindNeighborsRequest)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.FindNeighborsRequest)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.FindNeighborsRequest)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.FindNeighborsRequest)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.FindNeighborsRequest)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.FindNeighborsRequest)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.FindNeighborsRequest)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.FindNeighborsRequest)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.FindNeighborsRequest)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.FindNeighborsRequest)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.FindNeighborsRequest)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.FindNeighborsRequest)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.FindNeighborsRequest)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.FindNeighborsRequest)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.FindNeighborsRequest)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.FindNeighborsRequest)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.FindNeighborsRequest)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.FindNeighborsRequest)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.FindNeighborsRequest)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.FindNeighborsRequest)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.FindNeighborsRequest)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.FindNeighborsRequest)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.FindNeighborsRequest)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.FindNeighborsRequest)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.FindNeighborsRequest)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.FindNeighborsRequest)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.FindNeighborsRequest)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.FindNeighborsRequest)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.FindNeighborsRequest)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.FindNeighborsRequest)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.FindNeighborsRequest)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.FindNeighborsRequest) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class FindNeighborsRequest.\n\nThe request message for\n[MatchService.FindNeighbors](/php/docs/reference/cloud-ai-platform/latest/V1.Client.MatchServiceClient#_Google_Cloud_AIPlatform_V1_Client_MatchServiceClient__findNeighbors__).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.FindNeighborsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIndexEndpoint\n\nRequired. The name of the index endpoint.\n\nFormat:\n`projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`\n\n### setIndexEndpoint\n\nRequired. The name of the index endpoint.\n\nFormat:\n`projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`\n\n### getDeployedIndexId\n\nThe ID of the DeployedIndex that will serve the request. This request is\nsent to a specific IndexEndpoint, as per the IndexEndpoint.network. That\nIndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index\nhas a DeployedIndex.id field.\n\nThe value of the field below must equal one of the DeployedIndex.id\nfields of the IndexEndpoint that is being called for this request.\n\n### setDeployedIndexId\n\nThe ID of the DeployedIndex that will serve the request. This request is\nsent to a specific IndexEndpoint, as per the IndexEndpoint.network. That\nIndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index\nhas a DeployedIndex.id field.\n\nThe value of the field below must equal one of the DeployedIndex.id\nfields of the IndexEndpoint that is being called for this request.\n\n### getQueries\n\nThe list of queries.\n\n### setQueries\n\nThe list of queries.\n\n### getReturnFullDatapoint\n\nIf set to true, the full datapoints (including all vector values and\nrestricts) of the nearest neighbors are returned.\n\nNote that returning full datapoint will significantly increase the\nlatency and cost of the query.\n\n### setReturnFullDatapoint\n\nIf set to true, the full datapoints (including all vector values and\nrestricts) of the nearest neighbors are returned.\n\nNote that returning full datapoint will significantly increase the\nlatency and cost of the query."]]
