REST Resource: projects.locations.collections

資源：Collection

說明 Collection 物件的訊息

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
欄位
name

string

ID。資源名稱
displayName

string

選用。使用者指定的集合顯示名稱
description

string

選用。使用者指定的集合說明
createTime

string (Timestamp format)

僅供輸出。[Output only] 建立時間戳記

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。[Output only] 更新時間戳記

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

選用。以鍵/值組合形式呈現的標籤。

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
schema
(deprecated)

object (Struct format)

選用。已淘汰：資料的 JSON 結構定義。請改用 dataSchema。
vectorSchema

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

選用。向量欄位的結構定義。只有這個結構定義中的向量欄位可供搜尋。欄位名稱只能包含英數字元、底線和連字號。

包含 "key": value 組合清單的物件，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
dataSchema

object (Struct format)

選用。資料的 JSON 結構定義。欄位名稱只能包含英數字元、底線和連字號。

VectorField

描述向量欄位的訊息。

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.
}
欄位
聯集欄位 vector_type_config。向量類型設定。vector_type_config 只能是下列其中一個設定：
denseVector

object (DenseVectorField)

密集向量欄位。
sparseVector

object (SparseVectorField)

稀疏向量欄位。

DenseVectorField

描述密集向量欄位的訊息。

JSON 表示法 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
欄位
dimensions

integer

向量欄位的維度。
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

選用。為向量欄位生成嵌入項目的設定。如未指定，則必須在 DataObject 中填入嵌入欄位。

VertexEmbeddingConfig

訊息：說明如何使用 Vertex AI Embeddings API，為向量欄位生成嵌入。

JSON 表示法 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
欄位
modelId

string

這是必要旗標，必要：要使用的嵌入模型 ID。如要查看支援的模型清單，請參閱 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models。
textTemplate

string

這是必要旗標，必要條件：模型輸入內容的文字範本。範本必須包含一或多個對 DataObject 中欄位的參照，例如：「Movie Title: {title} ---- Movie Plot: {plot}」。
taskType

enum (EmbeddingTaskType)

這是必要旗標，必要：嵌入的任務類型。

EmbeddingTaskType

代表嵌入內容的用途。

列舉
EMBEDDING_TASK_TYPE_UNSPECIFIED 未指定工作類型。
RETRIEVAL_QUERY 指定指定文字是搜尋/擷取設定中的查詢。
RETRIEVAL_DOCUMENT 指定給定文字是所搜尋語料庫中的文件。
SEMANTIC_SIMILARITY 指定要將提供的文字用於 STS。
CLASSIFICATION 指定要分類的文字。
CLUSTERING 指定嵌入內容將用於叢集。
QUESTION_ANSWERING 指定嵌入內容將用於問答。
FACT_VERIFICATION 指定嵌入內容將用於事實查核。
CODE_RETRIEVAL_QUERY 指定要將嵌入內容用於程式碼擷取作業。

SparseVectorField

這個類型沒有任何欄位。

說明稀疏向量欄位的訊息。

方法

create

 在指定專案和位置建立新集合。

delete

 刪除單一集合。

exportDataObjects

 啟動長時間執行的作業，從集合匯出 DataObject。

get

 取得單一集合的詳細資料。

importDataObjects

 啟動長時間執行的作業，將 DataObject 匯入 Collection。

list

 列出指定專案和位置中的集合。

patch

 更新單一集合的參數。