View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FindNeighborsRequest (google_api_ai_platform v0.13.0)

The request message for MatchService.FindNeighbors.

Attributes

deployedIndexId (type: String.t, default: nil) - 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 (type: list(GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FindNeighborsRequestQuery.t), default: nil) - The list of queries.
returnFullDatapoint (type: boolean(), default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FindNeighborsRequest{
    deployedIndexId: String.t() | nil,
    queries:
      [
        GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1FindNeighborsRequestQuery.t()
      ]
      | nil,
    returnFullDatapoint: boolean() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.