REST Resource: projects.locations.collections.dataObjects

Resource: DataObject

A dataObject resource in Vector Search.

JSON representation 
{
  "name": string,
  "dataObjectId": string,
  "createTime": string,
  "updateTime": string,
  "data": {
    object
  },
  "vectors": {
    string: {
      object (Vector)
    },
    ...
  }
}
Fields
name

string

Identifier. The fully qualified resource name of the dataObject.

Format: projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObjectId} The dataObjectId must be 1-63 characters long, and comply with RFC1035.
dataObjectId
(deprecated)

string

Output only. The id of the dataObject.
createTime

string (Timestamp format)

Output only. Timestamp the dataObject was created at.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp the dataObject was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
data

object (Struct format)

Optional. The data of the dataObject.
vectors

map (key: string, value: object (Vector))

Optional. The vectors of the dataObject.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Vector

A vector which can be either dense or sparse.

JSON representation 
{
  "values": [
    number
  ],

  // Union field vector_type can be only one of the following:
  "dense": {
    object (DenseVector)
  },
  "sparse": {
    object (SparseVector)
  }
  // End of list of possible types for union field vector_type.
}
Fields
values[]
(deprecated)

number

The values of the vector.
Union field vector_type. The type of the vector. vector_type can be only one of the following:
dense

object (DenseVector)

A dense vector.
sparse

object (SparseVector)

A sparse vector.

DenseVector

A dense vector.

JSON representation 
{
  "values": [
    number
  ]
}
Fields
values[]

number

Required. The values of the vector.

SparseVector

A sparse vector.

JSON representation 
{
  "values": [
    number
  ],
  "indices": [
    integer
  ]
}
Fields
values[]

number

Required. The values of the vector.
indices[]

integer

Required. The corresponding indices for the values.

Methods

aggregate

 Aggregates data objects.

batchCreate

 Creates a batch of dataObjects.

batchDelete

 Deletes dataObjects in a batch.

batchSearch

 Batch searches data objects.

batchUpdate

 Updates dataObjects in a batch.

create

 Creates a dataObject.

delete

 Deletes a dataObject.

get

 Gets a data object.

patch

 Updates a dataObject.

query

 Queries data objects.
Searches data objects.