Package com.google.cloud.aiplatform.v1

Interface FindNeighborsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FindNeighborsRequest, FindNeighborsRequest.Builder
@Generated public interface FindNeighborsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getIndexEndpoint

      String getIndexEndpoint()
       Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The indexEndpoint.

    • getIndexEndpointBytes

      com.google.protobuf.ByteString getIndexEndpointBytes()
       Required. The name of the index endpoint.
 Format:
 `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`
      string index_endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for indexEndpoint.

    • getDeployedIndexId

      String getDeployedIndexId()
       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.
      string deployed_index_id = 2;
      Returns:
      The deployedIndexId.

    • getDeployedIndexIdBytes

      com.google.protobuf.ByteString getDeployedIndexIdBytes()
       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.
      string deployed_index_id = 2;
      Returns:
      The bytes for deployedIndexId.

    • getQueriesList

      List<FindNeighborsRequest.Query> getQueriesList()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

    • getQueries

      FindNeighborsRequest.Query getQueries(int index)
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

    • getQueriesCount

      int getQueriesCount()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

    • getQueriesOrBuilderList

      List<? extends FindNeighborsRequest.QueryOrBuilder> getQueriesOrBuilderList()
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

    • getQueriesOrBuilder

      FindNeighborsRequest.QueryOrBuilder getQueriesOrBuilder(int index)
       The list of queries.
      repeated .google.cloud.aiplatform.v1.FindNeighborsRequest.Query queries = 3;

    • getReturnFullDatapoint

      boolean getReturnFullDatapoint()
       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.
      bool return_full_datapoint = 4;
      Returns:
      The returnFullDatapoint.