Project: Vald (App Definition and Development / Database)
File: docs.md

<a name="top"></a> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <a name="v1payloadpayload-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="payload-v1-Control"></a> Control related messages. <a name="payload-v1-Control-CreateIndexRequest"></a> Represent the create index request. | Field | Type | Label | Description | | | -- | -- | -- | | pool_size | | | The pool size of the create index operation. | <a name="payload-v1-Discoverer"></a> Discoverer related messages. <a name="payload-v1-Discoverer-Request"></a> Represent the dicoverer request. | Field | Type | Label | Description | | | -- | -- | -- | | name | | | The agent name to be discovered. | | namespace | | | The namespace to be discovered. | | node | | | The node to be discovered. | <a name="payload-v1-Empty"></a> Represent an empty message. <a name="payload-v1-Filter"></a> Filter related messages. <a name="payload-v1-Filter-Config"></a> Represent filter configuration. | Field | Type | Label | Description | | - | | -- | | | targets | | repeated | Represent the filter target configuration. | <a name="payload-v1-Filter-Target"></a> Represent the target filter server. | Field | Type | Label | Description | | -- | -- | -- | -- | | host | | | The target hostname. | | port | | | The target port. | <a name="payload-v1-Flush"></a> Flush related messages. <a name="payload-v1-Flush-Request"></a> <a name="payload-v1-Info"></a> Info related messages. <a name="payload-v1-Info-Annotations"></a> Represent the kubernetes annotations. | Field | Type | Label | Description | | -- | - | -- | -- | | annotations | | repeated | | <a name="payload-v1-Info-Annotations-AnnotationsEntry"></a> | Field | Type | Label | Description | | -- | -- | -- | -- | | key | | | | | value | | | | <a name="payload-v1-Info-CPU"></a> Represent the CPU information message. | Field | Type | Label | Description | | - | -- | -- | | | limit | | | The CPU resource limit. | | request | | | The CPU resource requested. | | usage | | | The CPU usage. | <a name="payload-v1-Info-IPs"></a> Represent the multiple IP message. | Field | Type | Label | Description | | -- | -- | -- | -- | | ip | | repeated | | <a name="payload-v1-Info-Index"></a> Represent the index information messages. <a name="payload-v1-Info-Index-Count"></a> Represent the index count message. | Field | Type | Label | Description | | -- | -- | -- | - | | stored | | | The stored index count. | | uncommitted | | | The uncommitted index count. | | indexing | | | The indexing index count. | | saving | | | The saving index count. | <a name="payload-v1-Info-Index-UUID"></a> Represent the UUID message. <a name="payload-v1-Info-Index-UUID-Committed"></a> The committed UUID. | Field | Type | Label | Description | | -- | -- | -- | -- | | uuid | | | | <a name="payload-v1-Info-Index-UUID-Uncommitted"></a> The uncommitted UUID. | Field | Type | Label | Description | | -- | -- | -- | -- | | uuid | | | | <a name="payload-v1-Info-Labels"></a> Represent the kubernetes

| Field | Type | Label | Description | | | -- | -- | -- | | labels | | repeated | | <a name="payload-v1-Info-Labels-LabelsEntry"></a> | Field | Type | Label | Description | | -- | -- | -- | -- | | key | | | | | value | | | | <a name="payload-v1-Info-Memory"></a> Represent the memory information message. | Field | Type | Label | Description | | - | -- | -- | | | limit | | | The memory limit. | | request | | | The memory requested. | | usage | | | The memory usage. | <a name="payload-v1-Info-Node"></a> Represent the node information message. | Field | Type | Label | Description | | - | -- | -- | | | name | | | The name of the node. | | internal_addr | | | The internal IP address of the node. | | external_addr | | | The external IP address of the node. | | cpu | | | The CPU information of the node. | | memory | | | The memory information of the node. | | Pods | | | The pod information of the node. | <a name="payload-v1-Info-Nodes"></a> Represent the multiple node information message. | Field | Type | Label | Description | | -- | - | -- | | | nodes | | repeated | The multiple node information. | <a name="payload-v1-Info-Pod"></a> Represent the pod information message. | Field | Type | Label | Description | | | -- | -- | - | | app_name | | | The app name of the pod on the label. | | name | | | The name of the pod. | | namespace | | | The namespace of the pod. | | ip | | | The IP of the pod. | | cpu | | | The CPU information of the pod. | | memory | | | The memory information of the pod. | | node | | | The node information of the pod. | <a name="payload-v1-Info-Pods"></a> Represent the multiple pod information message. | Field | Type | Label | Description | | -- | -- | -- | -- | | pods | | repeated | The multiple pod information. | <a name="payload-v1-Info-Service"></a> Represent the service information message. | Field | Type | Label | Description | | -- | | -- | - | | name | | | The name of the svc. | | cluster_ip | | | The cluster ip of the svc. | | cluster_ips | | repeated | The cluster ips of the svc. | | ports | | repeated | The port of the svc. | | labels | | | The labels of the service. | | annotations | | | The annotations of the service. | <a name="payload-v1-Info-ServicePort"></a> Represets the service port information message. | Field | Type | Label | Description | | -- | -- | -- | | | name | | | The name of the port. | | port | | | The port number | <a name="payload-v1-Info-Services"></a> Represent the multiple service information message. | Field | Type | Label | Description | | -- | - | -- | | | services | | repeated | The multiple service information. | <a name="payload-v1-Insert"></a> Insert related messages. <a name="payload-v1-Insert-Config"></a> Represent insert configurations. | Field | Type | Label | Description | | -- | | -- | | | skipstrictexist_check | | | A flag to skip exist check during insert operation. | | filters | | | Filter configurations. | | timestamp | | | Insert

| <a name="payload-v1-Insert-MultiObjectRequest"></a> Represent the multiple insert by binary object request. | Field | Type | Label | Description | | -- | -- | -- | -- | | requests | | repeated | Represent multiple insert by object content. | <a name="payload-v1-Insert-MultiRequest"></a> Represent the multiple insert request. | Field | Type | Label | Description | | -- | -- | -- | | | requests | | repeated | Represent multiple insert request content. | <a name="payload-v1-Insert-ObjectRequest"></a> Represent the insert by binary object request. | Field | Type | Label | Description | | - | | -- | - | | object | | | The binary object to be inserted. | | config | | | The configuration of the insert request. | | vectorizer | | | Filter configurations. | <a name="payload-v1-Insert-Request"></a> Represent the insert request. | Field | Type | Label | Description | | | | -- | - | | vector | | | The vector to be inserted. | | config | | | The configuration of the insert request. | <a name="payload-v1-Mirror"></a> Mirror related messages. <a name="payload-v1-Mirror-Target"></a> Represent server information. | Field | Type | Label | Description | | -- | -- | -- | -- | | host | | | The target hostname. | | port | | | The target port. | <a name="payload-v1-Mirror-Targets"></a> Represent the multiple Target message. | Field | Type | Label | Description | | - | | -- | -- | | targets | | repeated | The multiple target information. | <a name="payload-v1-Object"></a> Common messages. <a name="payload-v1-Object-Blob"></a> Represent the binary object. | Field | Type | Label | Description | | | -- | -- | | | id | | | The object ID. | | object | | | The binary object. | <a name="payload-v1-Object-Distance"></a> Represent the ID and distance pair. | Field | Type | Label | Description | | -- | -- | -- | -- | | id | | | The vector ID. | | distance | | | The distance. | <a name="payload-v1-Object-GetTimestampRequest"></a> Represent a request to fetch vector meta data. | Field | Type | Label | Description | | -- | - | -- | - | | id | | | The vector ID to be fetched. | <a name="payload-v1-Object-ID"></a> Represent the vector ID. | Field | Type | Label | Description | | -- | -- | -- | -- | | id | | | | <a name="payload-v1-Object-IDs"></a> Represent multiple vector IDs. | Field | Type | Label | Description | | -- | -- | -- | -- | | ids | | repeated | | <a name="payload-v1-Object-List"></a> Represent the list object vector stream request and response. <a name="payload-v1-Object-List-Request"></a> <a name="payload-v1-Object-List-Response"></a> | Field | Type | Label | Description | | | | -- | | | vector | | | The vector | | status | | | The RPC error status. | <a name="payload-v1-Object-Location"></a> Represent the vector location. | Field | Type | Label | Description | | -- | -- | -- | - | | name | | | The name of the location. | | uuid | | | The UUID of the vector. | | ips | | repeated | The IP list. | <a name="payload-v1-Object-Locations"></a> Represent multiple vector locations. | Field | Type | Label | Description | | | - | -- | -- | | locations | | repeated | | <a name="payload-v1-Object-ReshapeVector"></a> Represent reshape

| Field | Type | Label | Description | | | | -- | | | object | | | The binary object. | | shape | | repeated | The new shape. | <a name="payload-v1-Object-StreamBlob"></a> Represent stream response of binary objects. | Field | Type | Label | Description | | | | -- | | | blob | | | The binary object. | | status | | | The RPC error status. | <a name="payload-v1-Object-StreamDistance"></a> Represent stream response of distances. | Field | Type | Label | Description | | -- | - | -- | | | distance | | | The distance. | | status | | | The RPC error status. | <a name="payload-v1-Object-StreamLocation"></a> Represent the stream response of the vector location. | Field | Type | Label | Description | | -- | - | -- | | | location | | | The vector location. | | status | | | The RPC error status. | <a name="payload-v1-Object-StreamVector"></a> Represent stream response of the vector. | Field | Type | Label | Description | | | | -- | | | vector | | | The vector. | | status | | | The RPC error status. | <a name="payload-v1-Object-Timestamp"></a> Represent a vector meta data. | Field | Type | Label | Description | | | -- | -- | -- | | id | | | The vector ID. | | timestamp | | | timestamp represents when this vector inserted. | <a name="payload-v1-Object-Vector"></a> Represent a vector. | Field | Type | Label | Description | | | -- | -- | -- | | id | | | The vector ID. | | vector | | repeated | The vector. | | timestamp | | | timestamp represents when this vector inserted. | <a name="payload-v1-Object-VectorRequest"></a> Represent a request to fetch raw vector. | Field | Type | Label | Description | | - | | -- | - | | id | | | The vector ID to be fetched. | | filters | | | Filter configurations. | <a name="payload-v1-Object-Vectors"></a> Represent multiple vectors. | Field | Type | Label | Description | | - | | -- | -- | | vectors | | repeated | | <a name="payload-v1-Remove"></a> Remove related messages. <a name="payload-v1-Remove-Config"></a> Represent the remove configuration. | Field | Type | Label | Description | | -- | | -- | | | skipstrictexist_check | | | A flag to skip exist check during upsert operation. | | timestamp | | | Remove timestamp. | <a name="payload-v1-Remove-MultiRequest"></a> Represent the multiple remove request. | Field | Type | Label | Description | | -- | -- | -- | - | | requests | | repeated | Represent the multiple remove request content. | <a name="payload-v1-Remove-Request"></a> Represent the remove request. | Field | Type | Label | Description | | | | -- | - | | id | | | The object ID to be removed. | | config | | | The configuration of the remove request. | <a name="payload-v1-Remove-Timestamp"></a> Represent the timestamp comparison. | Field | Type | Label | Description | | | | -- | - | | timestamp | | | The timestamp. | | operator | | | The conditional operator. | <a name="payload-v1-Remove-TimestampRequest"></a> Represent the remove request based on timestamp. | Field | Type | Label | Description | | - | | -- | | | timestamps | | repeated | The timestamp comparison list. If more than one is specified, the `AND` search is applied. | <a name="payload-v1-Search"></a> Search related messages. <a name="payload-v1-Search-Config"></a> Represent search

| Field | Type | Label | Description | | | - | -- | -- | | request_id | | | Unique request ID. | | num | | | Maximum number of result to be returned. | | radius | | | Search radius. | | epsilon | | | Search coefficient. | | timeout | | | Search timeout in nanoseconds. | | ingress_filters | | | Ingress filter configurations. | | egress_filters | | | Egress filter configurations. | | min_num | | | Minimum number of result to be returned. | | aggregation_algorithm | | | Aggregation Algorithm | | ratio | | | Search ratio for agent return result number. | <a name="payload-v1-Search-IDRequest"></a> Represent a search by ID request. | Field | Type | Label | Description | | | | -- | - | | id | | | The vector ID to be searched. | | config | | | The configuration of the search request. | <a name="payload-v1-Search-MultiIDRequest"></a> Represent the multiple search by ID request. | Field | Type | Label | Description | | -- | | -- | - | | requests | | repeated | Represent the multiple search by ID request content. | <a name="payload-v1-Search-MultiObjectRequest"></a> Represent the multiple search by binary object request. | Field | Type | Label | Description | | -- | -- | -- | | | requests | | repeated | Represent the multiple search by binary object request content. | <a name="payload-v1-Search-MultiRequest"></a> Represent the multiple search request. | Field | Type | Label | Description | | -- | -- | -- | - | | requests | | repeated | Represent the multiple search request content. | <a name="payload-v1-Search-ObjectRequest"></a> Represent a search by binary object request. | Field | Type | Label | Description | | - | | -- | - | | object | | | The binary object to be searched. | | config | | | The configuration of the search request. | | vectorizer | | | Filter configuration. | <a name="payload-v1-Search-Request"></a> Represent a search request. | Field | Type | Label | Description | | | | -- | - | | vector | | repeated | The vector to be searched. | | config | | | The configuration of the search request. | <a name="payload-v1-Search-Response"></a> Represent a search response. | Field | Type | Label | Description | | - | - | -- | - | | request_id | | | The unique request ID. | | results | | repeated | Search results. | <a name="payload-v1-Search-Responses"></a> Represent multiple search responses. | Field | Type | Label | Description | | | - | -- | -- | | responses | | repeated | Represent the multiple search response content. | <a name="payload-v1-Search-StreamResponse"></a> Represent stream search response. | Field | Type | Label | Description | | -- | - | -- | | | response | | | Represent the search response. | | status | | | The RPC error status. | <a name="payload-v1-Update"></a> Update related messages <a name="payload-v1-Update-Config"></a> Represent the update configuration. | Field | Type | Label | Description | | -- | | -- | | | skipstrictexist_check | | | A flag to skip exist check during update operation. | | filters | | | Filter configuration. | | timestamp | | | Update timestamp. | | disablebalancedupdate | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. | <a name="payload-v1-Update-MultiObjectRequest"></a> Represent the multiple update binary object

| Field | Type | Label | Description | | -- | -- | -- | -- | | requests | | repeated | Represent the multiple update object request content. | <a name="payload-v1-Update-MultiRequest"></a> Represent the multiple update request. | Field | Type | Label | Description | | -- | -- | -- | - | | requests | | repeated | Represent the multiple update request content. | <a name="payload-v1-Update-ObjectRequest"></a> Represent the update binary object request. | Field | Type | Label | Description | | - | | -- | - | | object | | | The binary object to be updated. | | config | | | The configuration of the update request. | | vectorizer | | | Filter target. | <a name="payload-v1-Update-Request"></a> Represent the update request. | Field | Type | Label | Description | | | | -- | - | | vector | | | The vector to be updated. | | config | | | The configuration of the update request. | <a name="payload-v1-Upsert"></a> Upsert related messages. <a name="payload-v1-Upsert-Config"></a> Represent the upsert configuration. | Field | Type | Label | Description | | -- | | -- | | | skipstrictexist_check | | | A flag to skip exist check during upsert operation. | | filters | | | Filter configuration. | | timestamp | | | Upsert timestamp. | | disablebalancedupdate | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. | <a name="payload-v1-Upsert-MultiObjectRequest"></a> Represent the multiple upsert binary object request. | Field | Type | Label | Description | | -- | -- | -- | -- | | requests | | repeated | Represent the multiple upsert object request content. | <a name="payload-v1-Upsert-MultiRequest"></a> Represent mthe ultiple upsert request. | Field | Type | Label | Description | | -- | -- | -- | - | | requests | | repeated | Represent the multiple upsert request content. | <a name="payload-v1-Upsert-ObjectRequest"></a> Represent the upsert binary object request. | Field | Type | Label | Description | | - | | -- | - | | object | | | The binary object to be upserted. | | config | | | The configuration of the upsert request. | | vectorizer | | | Filter target. | <a name="payload-v1-Upsert-Request"></a> Represent the upsert request. | Field | Type | Label | Description | | | | -- | - | | vector | | | The vector to be upserted. | | config | | | The configuration of the upsert request. | <a name="payload-v1-Remove-Timestamp-Operator"></a> Operator is enum of each conditional operator. | Name | Number | Description | | - | | -- | | Eq | 0 | The timestamp is equal to the specified value in the request. | | Ne | 1 | The timestamp is not equal to the specified value in the request. | | Ge | 2 | The timestamp is greater than or equal to the specified value in the request. | | Gt | 3 | The timestamp is greater than the specified value in the request. | | Le | 4 | The timestamp is less than or equal to the specified value in the request. | | Lt | 5 | The timestamp is less than the specified value in the

| <a name="payload-v1-Search-AggregationAlgorithm"></a> AggregationAlgorithm is enum of each aggregation algorithms | Name | Number | Description | | | | -- | | Unknown | 0 | | | ConcurrentQueue | 1 | | | SortSlice | 2 | | | SortPoolSlice | 3 | | | PairingHeap | 4 | | <a name="v1agentcore_agent-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="core-v1-Agent"></a> Represent the agent service. | Method Name | Request Type | Response Type | Description | | | -- | | -- | | CreateIndex | | | Represent the creating index RPC. | | SaveIndex | | | Represent the saving index RPC. | | CreateAndSaveIndex | | | Represent the creating and saving index RPC. | | IndexInfo | | | Represent the RPC to get the agent index information. | | GetTimestamp | | | Represent the RPC to get the vector metadata. This RPC is mainly used for index correction process | <a name="v1agentsidecar_sidecar-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="sidecar-v1-Sidecar"></a> Represent the agent sidecar service. | Method Name | Request Type | Response Type | Description | | -- | | - | -- | <a name="v1discovererdiscoverer-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="discoverer-v1-Discoverer"></a> Represent the discoverer service. | Method Name | Request Type | Response Type | Description | | -- | - | | | | Pods | | | Represent the RPC to get the agent pods information. | | Nodes | | | Represent the RPC to get the node information. | | Services | | | Represent the RPC to get the readreplica svc information. | <a name="v1filteregressegressfilter-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="filter-egress-v1-Filter"></a> Represent the egress filter service. | Method Name | Request Type | Response Type | Description | | -- | - | - | -- | | FilterDistance | | | Represent the RPC to filter the distance. | | FilterVector | | | Represent the RPC to filter the vector. | <a name="v1filteringressingressfilter-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="filter-ingress-v1-Filter"></a> Represent the ingress filter service. | Method Name | Request Type | Response Type | Description | | | | | -- | | GenVector | | | Represent the RPC to generate the vector. | | FilterVector | | | Represent the RPC to filter the vector. | <a name="v1managerindexindexmanager-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="manager-index-v1-Index"></a> Represent the index manager service. | Method Name | Request Type | Response Type | Description | | -- | -- | | -- | | IndexInfo | | | Represent the RPC to get the index information. | <a name="v1mirrormirror-proto"></a> <p align="right"><a href="#top">Top</a></p> Copyright (C) 2019-2024 vdaas.org vald team &lt;vald@vdaas.org&gt; Licensed under the Apache License, Version 2.0 (the &#34;License&#34;); You may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &#34;AS IS&#34; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. <a name="mirror-v1-Mirror"></a> Represent the mirror service. | Method Name | Request Type | Response Type | Description | | -- | -- | -- | -- | | Register | | | Register is the RPC to register other mirror servers. | <a name="v1rpcerrdetailserrordetails-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="rpc-v1-BadRequest"></a> Describes violations in a client request. This error type focuses on the syntactic aspects of the request. | Field | Type | Label | Description | | - | -- | -- | | | field_violations | | repeated | Describes all violations in a client request. | <a name="rpc-v1-BadRequest-FieldViolation"></a> A message type used to describe a single bad request

| Field | Type | Label | Description | | -- | -- | -- | -- | | field | | | A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. | Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string fullname = 1; repeated EmailAddress emailaddresses = 2; } In this example, in proto `field` could take one of the following values: `fullname` for a violation in the `fullname` value `emailaddresses[1].email` for a violation in the `email` field of the first `emailaddresses` message `emailaddresses[3].type[2]` for a violation in the second `type` value in the third `emailaddresses` message. In JSON, the same values are represented as: `fullName` for a violation in the `fullName` value `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. | | description | | | A description of why the request element is bad. | <a name="rpc-v1-DebugInfo"></a> Describes additional debugging info. | Field | Type | Label | Description | | - | -- | -- | | | stack_entries | | repeated | The stack trace entries indicating where the error occurred. | | detail | | | Additional debugging information provided by the server. | <a name="rpc-v1-ErrorInfo"></a> Describes the cause of the error with structured details. Example of an error when contacting the &#34;pubsub.googleapis.com&#34; API when it is not enabled: { &#34;reason&#34;: &#34;API_DISABLED&#34; &#34;domain&#34;: &#34;googleapis.com&#34; &#34;metadata&#34;: { &#34;resource&#34;: &#34;projects/123&#34;, &#34;service&#34;: &#34;pubsub.googleapis.com&#34; } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { &#34;reason&#34;: &#34;STOCKOUT&#34; &#34;domain&#34;: &#34;spanner.googleapis.com&#34;, &#34;metadata&#34;: { &#34;availableRegions&#34;: &#34;us-central1,us-east2&#34; } } | Field | Type | Label | Description | | -- | - | -- | - | | reason | | | The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `&#43;[A-Z0-9]`, which represents UPPERSNAKECASE. | | domain | | | The logical grouping to which the &#34;reason&#34; belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: &#34;pubsub.googleapis.com&#34;. If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is &#34;googleapis.com&#34;. | | metadata | | repeated | Additional structured details about this error. | Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {&#34;instanceLimit&#34;: &#34;100/request&#34;}, should be returned as, {&#34;instanceLimitPerRequest&#34;: &#34;100&#34;}, if the client exceeds the number of instances that can be created in a single (batch) request. | <a name="rpc-v1-ErrorInfo-MetadataEntry"></a> | Field | Type | Label | Description | | -- | -- | -- | -- | | key | | | | | value | | | | <a name="rpc-v1-Help"></a> Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling

hasn&#39;t enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. | Field | Type | Label | Description | | -- | | -- | | | links | | repeated | URL(s) pointing to additional information on handling the current error. | <a name="rpc-v1-Help-Link"></a> Describes a URL link. | Field | Type | Label | Description | | -- | -- | -- | - | | description | | | Describes what the link offers. | | url | | | The URL of the link. | <a name="rpc-v1-LocalizedMessage"></a> Provides a localized error message that is safe to return to the user which can be attached to an RPC error. | Field | Type | Label | Description | | - | -- | -- | -- | | locale | | | The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: &#34;en-US&#34;, &#34;fr-CH&#34;, &#34;es-MX&#34; | | message | | | The localized error message in the above locale. | <a name="rpc-v1-PreconditionFailure"></a> Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message. | Field | Type | Label | Description | | - | - | -- | -- | | violations | | repeated | Describes all precondition violations. | <a name="rpc-v1-PreconditionFailure-Violation"></a> A message type used to describe a single precondition failure. | Field | Type | Label | Description | | -- | -- | -- | -- | | type | | | The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, &#34;TOS&#34; for &#34;Terms of Service violation&#34;. | | subject | | | The subject, relative to the type, that failed. For example, &#34;google.com/cloud&#34; relative to the &#34;TOS&#34; type would indicate which terms of service is being referenced. | | description | | | A description of how the precondition failed. Developers can use this description to understand how to fix the failure. | For example: &#34;Terms of service not accepted&#34;. | <a name="rpc-v1-QuotaFailure"></a> Describes how a quota check failed. For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn&#39;t enabled the service in the developer console, then a service could respond with the project id and set `service_disabled` to true. Also see RetryInfo and Help types for other details about handling a quota failure. | Field | Type | Label | Description | | - | -- | -- | - | | violations | | repeated | Describes all quota violations. | <a name="rpc-v1-QuotaFailure-Violation"></a> A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded. | Field | Type | Label | Description | | -- | -- | -- | -- | | subject | | | The subject on which the quota check failed. For example, &#34;clientip:&lt;ip address of client&gt;&#34; or &#34;project:&lt;Google developer project id&gt;&#34;. | | description | | | A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service&#39;s public documentation, or find the relevant quota limit to adjust through developer console. | For example: &#34;Service disabled&#34; or &#34;Daily Limit for read

exceeded&#34;. | <a name="rpc-v1-RequestInfo"></a> Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback. | Field | Type | Label | Description | | | -- | -- | - | | request_id | | | An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service&#39;s logs. | | serving_data | | | Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging. | <a name="rpc-v1-ResourceInfo"></a> Describes the resource that is being accessed. | Field | Type | Label | Description | | - | -- | -- | | | resource_type | | | A name for the type of resource being accessed, e.g. &#34;sql table&#34;, &#34;cloud storage bucket&#34;, &#34;file&#34;, &#34;Google calendar&#34;; or the type URL of the resource: e.g. &#34;type.googleapis.com/google.pubsub.v1.Topic&#34;. | | resourcename | | | The name of the resource being accessed. For example, a shared calendar name: &#34;example.com4fghdhgsrgh@group.calendar.google.com&#34;, if the current error is . | | owner | | | The owner of the resource (optional). For example, &#34;user:&lt;owner email&gt;&#34; or &#34;project:&lt;Google developer project id&gt;&#34;. | | description | | | Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the `writer` permission on the developer console project. | <a name="rpc-v1-RetryInfo"></a> Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It&#39;s always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached. | Field | Type | Label | Description | | -- | -- | -- | - | | retry_delay | | | Clients should wait at least this long between retrying the same request. | <a name="v1valdfilter-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Filter"></a> Filter service provides ways to connect to Vald through filter. | Method Name | Request Type | Response Type | Description | | | | -- | | | SearchObject | | | A method to search object. | | MultiSearchObject | | | A method to search multiple objects. | | StreamSearchObject | stream | stream | A method to search object by bidirectional streaming. | | InsertObject | | | A method insert object. | | StreamInsertObject | stream | stream | Represent the streaming RPC to insert object by bidirectional streaming. | | MultiInsertObject | | | A method to insert multiple objects. | | UpdateObject | | | A method to update object. | | StreamUpdateObject | stream | stream | A method to update object by bidirectional streaming. | | MultiUpdateObject | | | A method to update multiple objects. | | UpsertObject | | | A method to upsert object. | | StreamUpsertObject | stream | stream | A method to upsert object by bidirectional streaming. | | MultiUpsertObject | | | A method to upsert multiple objects. | <a name="v1valdflush-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Flush"></a> Flush service provides ways to flush all indexed

| Method Name | Request Type | Response Type | Description | | -- | | | - | | Flush | | | A method to flush all indexed vector. | <a name="v1valdinsert-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Insert"></a> Insert service provides ways to add new vectors. | Method Name | Request Type | Response Type | Description | | | | -- | - | | Insert | | | A method to add a new single vector. | | StreamInsert | stream | stream | A method to add new multiple vectors by bidirectional streaming. | | MultiInsert | | | A method to add new multiple vectors in a single request. | <a name="v1valdobject-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Object"></a> Object service provides ways to fetch indexed vectors. | Method Name | Request Type | Response Type | Description | | - | | | -- | | Exists | | | A method to check whether a specified ID is indexed or not. | | GetObject | | | A method to fetch a vector. | | StreamGetObject | stream | stream | A method to fetch vectors by bidirectional streaming. | | StreamListObject | | stream | A method to get all the vectors with server streaming | <a name="v1valdremove-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Remove"></a> Remove service provides ways to remove indexed vectors. | Method Name | Request Type | Response Type | Description | | -- | -- | -- | -- | | Remove | | | A method to remove an indexed vector. | | RemoveByTimestamp | | | A method to remove an indexed vector based on timestamp. | | StreamRemove | stream | stream | A method to remove multiple indexed vectors by bidirectional streaming. | | MultiRemove | | | A method to remove multiple indexed vectors in a single request. | <a name="v1valdsearch-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Search"></a> Search service provides ways to search indexed vectors. | Method Name | Request Type | Response Type | Description | | - | - | -- | - | | Search | | | A method to search indexed vectors by a raw vector. | | SearchByID | | | A method to search indexed vectors by ID. | | StreamSearch | stream | stream | A method to search indexed vectors by multiple vectors. | | StreamSearchByID | stream | stream | A method to search indexed vectors by multiple IDs. | | MultiSearch | | | A method to search indexed vectors by multiple vectors in a single request. | | MultiSearchByID | | | A method to search indexed vectors by multiple IDs in a single request. | | LinearSearch | | | A method to linear search indexed vectors by a raw vector. | | LinearSearchByID | | | A method to linear search indexed vectors by ID. | | StreamLinearSearch | stream | stream | A method to linear search indexed vectors by multiple vectors. | | StreamLinearSearchByID | stream | stream | A method to linear search indexed vectors by multiple IDs. | | MultiLinearSearch | | | A method to linear search indexed vectors by multiple vectors in a single request. | | MultiLinearSearchByID | | | A method to linear search indexed vectors by multiple IDs in a single request. | <a name="v1valdupdate-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Update"></a> Update service provides ways to update indexed vectors. | Method Name | Request Type | Response Type | Description | | | | -- | -- | | Update | | | A method to update an indexed vector. | | StreamUpdate | stream | stream | A method to update multiple indexed vectors by bidirectional

| | MultiUpdate | | | A method to update multiple indexed vectors in a single request. | <a name="v1valdupsert-proto"></a> <p align="right"><a href="#top">Top</a></p> <a name="vald-v1-Upsert"></a> Upsert service provides ways to insert/update vectors. | Method Name | Request Type | Response Type | Description | | | | -- | - | | Upsert | | | A method to insert/update a vector. | | StreamUpsert | stream | stream | A method to insert/update multiple vectors by bidirectional streaming. | | MultiUpsert | | | A method to insert/update multiple vectors in a single request. | | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | | -- | | - | -- | - | - | -- | | | <a name="double" /> double | | double | double | float | float64 | double | float | Float | | <a name="float" /> float | | float | float | float | float32 | float | float | Float | | <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT)