REST Resource: projects.locations.collections

Resource: Koleksi

Pesan yang menjelaskan objek Koleksi

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  }
}
Kolom
name

string

ID. Nama resource
displayName

string

Opsional. Nama tampilan kumpulan yang ditentukan pengguna
description

string

Opsional. Deskripsi koleksi yang ditentukan pengguna
createTime

string (Timestamp format)

Hanya output. [Khusus output] Stempel waktu pembuatan

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. [Khusus output] Stempel waktu pembaruan

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opsional. Label sebagai pasangan nilai kunci.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
schema
(deprecated)

object (Struct format)

Opsional. Tidak digunakan lagi: Skema JSON untuk data. Sebagai gantinya, gunakan dataSchema.
vectorSchema

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

Opsional. Skema untuk kolom vektor. Hanya kolom vektor dalam skema ini yang dapat ditelusuri. Nama kolom hanya boleh berisi karakter alfanumerik, garis bawah, dan tanda hubung.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
dataSchema

object (Struct format)

Opsional. Skema JSON untuk data. Nama kolom hanya boleh berisi karakter alfanumerik, garis bawah, dan tanda hubung. Skema harus sesuai dengan JSON Schema Draft 7.
encryptionSpec

object (EncryptionSpec)

Opsional. Tidak dapat diubah. Menentukan spesifikasi kunci enkripsi yang dikelola pelanggan untuk Koleksi. Jika disetel, Koleksi ini dan semua sub-resource Koleksi ini akan diamankan oleh kunci ini.

VectorField

Pesan yang menjelaskan kolom vektor.

Representasi JSON 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
Kolom
Kolom union vector_type_config. Konfigurasi jenis vektor. vector_type_config hanya ada berupa salah satu diantara berikut:
denseVector

object (DenseVectorField)

Bidang vektor padat.
sparseVector

object (SparseVectorField)

Medan vektor renggang.

DenseVectorField

Pesan yang menjelaskan kolom vektor padat.

Representasi JSON 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
Kolom
dimensions

integer

Dimensi kolom vektor.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

Opsional. Konfigurasi untuk membuat embedding untuk kolom vektor. Jika tidak ditentukan, kolom sematan harus diisi di DataObject.

VertexEmbeddingConfig

Pesan yang menjelaskan konfigurasi untuk membuat embedding untuk kolom vektor menggunakan Vertex AI Embeddings API.

Representasi JSON 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
Kolom
modelId

string

Wajib. Wajib: ID model embedding yang akan digunakan. Lihat https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models untuk mengetahui daftar model yang didukung.
textTemplate

string

Wajib. Wajib: Template teks untuk input ke model. Template harus berisi satu atau beberapa referensi ke kolom di DataObject, misalnya: "Movie Title: {title} ---- Movie Plot: {plot}".
taskType

enum (EmbeddingTaskType)

Wajib. Wajib: Jenis tugas untuk embedding.

EmbeddingTaskType

Mewakili tugas yang akan menggunakan embedding.

Enum
EMBEDDING_TASK_TYPE_UNSPECIFIED Jenis tugas tidak ditentukan.
RETRIEVAL_QUERY Menentukan bahwa teks yang diberikan merupakan kueri dalam setelan penelusuran/pengambilan.
RETRIEVAL_DOCUMENT Menentukan bahwa teks yang diberikan adalah dokumen dari korpus yang sedang ditelusuri.
SEMANTIC_SIMILARITY Menentukan bahwa teks yang diberikan akan digunakan untuk STS.
CLASSIFICATION Menentukan bahwa teks yang diberikan akan diklasifikasikan.
CLUSTERING Menentukan bahwa embedding akan digunakan untuk pengelompokan.
QUESTION_ANSWERING Menentukan bahwa embedding akan digunakan untuk menjawab pertanyaan.
FACT_VERIFICATION Menentukan bahwa embedding akan digunakan untuk verifikasi fakta.
CODE_RETRIEVAL_QUERY Menentukan bahwa embedding akan digunakan untuk pengambilan kode.

SparseVectorField

Jenis ini tidak memiliki kolom.

Pesan yang menjelaskan kolom vektor renggang.

EncryptionSpec

Mewakili spesifikasi kunci enkripsi yang dikelola pelanggan yang dapat diterapkan ke koleksi Vector Search.

Representasi JSON 
{
  "cryptoKeyName": string
}
Kolom
cryptoKeyName

string

Wajib. Nama resource kunci Cloud KMS yang digunakan untuk melindungi resource.

Kunci Cloud KMS harus berada di region yang sama dengan resource. Harus memiliki format projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Metode

create

 Membuat Koleksi baru di project dan lokasi tertentu.

delete

 Menghapus satu Koleksi.

exportDataObjects

 Memulai Operasi yang Berjalan Lama untuk mengekspor DataObject dari Koleksi.

get

 Mendapatkan detail satu Koleksi.

importDataObjects

 Memulai Operasi yang Berjalan Lama untuk mengimpor DataObject ke dalam Kumpulan.

list

 Mencantumkan Koleksi dalam project dan lokasi tertentu.

patch

 Memperbarui parameter satu Koleksi.