REST Resource: corpora.documents.chunks

資源：Chunk

Chunk 是 Document 的子部分，用於向量表示法和儲存用途。Corpus 最多可有 100 萬個 Chunk。

JSON 表示法 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
欄位
name

string

無法變更。ID。Chunk 資源名稱。ID (名稱不包含「corpora/*/documents/*/chunks/」前置字串) 且最多可以包含 40 個字元，可使用小寫英數字元或破折號 (-)，且 ID 的開頭或結尾不得為破折號。如果建立時名稱空白，就會隨機產生 12 個字元的專屬 ID。範例：corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c
data

object (ChunkData)

必要欄位。Chunk 的內容，例如文字字串。每個區塊的符記數量上限為 2043 個。
customMetadata[]

object (CustomMetadata)

選用設定。使用者提供的自訂中繼資料以鍵/值組合的形式儲存。每個區塊的 CustomMetadata 數量上限為 20 個。
createTime

string (Timestamp format)

僅供輸出。Chunk 建立時的時間戳記。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。Chunk 上次更新時間的時間戳記。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
state

enum (State)

僅供輸出。Chunk 的目前狀態。

ChunkData

代表 Chunk 內容的擷取資料。

JSON 表示法 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
欄位

聯集欄位 data。

data 只能採用下列其中一種設定：
stringValue

string

以字串形式顯示的 Chunk 內容。每個區塊的符記數量上限為 2043 個。

狀態

Chunk 生命週期的狀態。

列舉
STATE_UNSPECIFIED 預設值。如果省略狀態，就會使用這個值。
STATE_PENDING_PROCESSING 正在處理 Chunk (嵌入和向量儲存空間)。
STATE_ACTIVE Chunk 已處理且可供查詢。
STATE_FAILED 處理「Chunk」失敗。

方法

batchCreate

 批次建立 Chunk。

batchDelete

 批次刪除 Chunk。

batchUpdate

 批次更新 Chunk。

create

 可建立 Chunk。

delete

 刪除 Chunk。

get

 取得特定 Chunk 的相關資訊。

list

 列出 Document 中的所有 Chunk。

patch

 更新 Chunk。