Chunks

REST 資源：corpora.documents.chunks

資源：Chunk

Chunk 是 Document 的子部分，系統會將其視為獨立單位，用於向量表示和儲存。Corpus 的 Chunk 上限為 100 萬個。

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)

選用設定。使用者提供的自訂中繼資料是以鍵/值組合的形式儲存。每個區塊最多可有 20 個 CustomMetadata。

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處理失敗。

方法：corpora.documents.chunks.create

可建立 Chunk。

端點

則貼文 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks 。

路徑參數

parent string

必要欄位。要建立這個 Chunk 的 Document 名稱。範例：corpora/my-corpus-123/documents/the-doc-abc 的格式為 corpora/{corpora}/documents/{document}。

要求主體

要求主體包含 Chunk 的例項。

回應主體

如果成功，回應主體會包含新建立的 Chunk 例項。

方法：corpora.documents.chunks.list

列出 Document 中的所有 Chunk。

端點

取得 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks 。

路徑參數

parent string

必要欄位。包含 Chunk 的 Document 名稱。範例：corpora/my-corpus-123/documents/the-doc-abc 的格式為 corpora/{corpora}/documents/{document}。

查詢參數

pageSize integer

選用設定。可傳回的 Chunk 數量上限 (每頁)。服務傳回的 Chunk 數量可能會減少。

如未指定，最多會傳回 10 個 Chunk。每頁的大小上限為 100 Chunk 秒。

pageToken string

選用設定。屬於接收自前一個 chunks.list 呼叫的網頁權杖。

提供回應中傳回的 nextPageToken 做為引數，以便擷取下一個網頁。

進行分頁時，提供至 chunks.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

來自 chunks.list 的回應，其中包含 Chunk 的分頁清單。Chunk 是依 chunk.create_time 遞增排序。

如果成功，回應主體即會包含具有以下結構的資料：

欄位
chunks[] object (Chunk)

傳回的 Chunk。

nextPageToken string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就沒有其他頁面。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

方法：corpora.documents.chunks.get

取得特定 Chunk 的資訊。

端點

取得 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*} 。

路徑參數

name string

必要欄位。要擷取的 Chunk 名稱。範例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk 的格式為 corpora/{corpora}/documents/{document}/chunks/{chunk}。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Chunk 的執行例項。

方法：corpora.documents.chunks.patch

更新 Chunk。

端點

修補程式 https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*} 。

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

路徑參數

chunk.name string

不可變動。ID。Chunk 資源名稱。ID (名稱不含「corpora/*/documents/*/chunks/」前置字串) 最多可包含 40 個小寫英數字元或破折號 (-)。ID 的開頭或結尾不得為破折號。如果建立時沒有名稱，系統會隨機產生 12 個字元的專屬 ID。範例：corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c 的格式為 corpora/{corpora}/documents/{document}/chunks/{chunk}。

查詢參數

updateMask string (FieldMask format)

必要欄位。要更新的欄位清單。目前僅支援更新 customMetadata 和 data。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 Chunk 的例項。

回應主體

如果成功，回應主體會包含 Chunk 的執行例項。

方法：corpora.documents.chunks.delete

刪除 Chunk。

端點

刪除 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*} 。

路徑參數

name string

必要欄位。要刪除的 Chunk 資源名稱。範例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk 的格式為 corpora/{corpora}/documents/{document}/chunks/{chunk}。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會是空白的。

方法：corpora.documents.chunks.batchCreate

批次建立 Chunk。

端點

則貼文 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate 。

路徑參數

parent string

選用設定。要建立此批次 Chunk 的 Document 名稱。每個 CreateChunkRequest 中的父項欄位都必須與這個值相符。範例：corpora/my-corpus-123/documents/the-doc-abc 的格式為 corpora/{corpora}/documents/{document}。

要求主體

要求主體的資料會採用以下結構：

欄位
requests[] object (CreateChunkRequest)

必要欄位。指定待建立 Chunk 的要求訊息。一個批次最多可建立 100 個 Chunk。

回應主體

來自 chunks.batchCreate 的回應，其中包含已建立的 Chunk 清單。

如果成功，回應主體即會包含具有以下結構的資料：

欄位
chunks[] object (Chunk)

已建立Chunk。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

要求建立 Chunk。

JSON 表示法 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
欄位
parent string

必要欄位。要建立這個 Chunk 的 Document 名稱。範例：corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

必要欄位。要建立的 Chunk。

方法：corpora.documents.chunks.batchUpdate

批次更新 Chunk 秒。

端點

則貼文 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate 。

路徑參數

parent string

選用設定。包含要更新的 Chunk 的 Document 名稱。每個 UpdateChunkRequest 中的父項欄位都必須與這個值相符。範例：corpora/my-corpus-123/documents/the-doc-abc 的格式為 corpora/{corpora}/documents/{document}。

要求主體

要求主體的資料會採用以下結構：

欄位
requests[] object (UpdateChunkRequest)

必要欄位。用於指定要更新 Chunks 的要求訊息。一個批次最多可更新 100 個 Chunk。

回應主體

來自 chunks.batchUpdate 的回應，其中包含已更新的 Chunk 清單。

如果成功，回應主體即會包含具有以下結構的資料：

欄位
chunks[] object (Chunk)

已更新 Chunk。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

要求更新 Chunk。

JSON 表示法 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
欄位
chunk object (Chunk)

必要欄位。要更新的 Chunk。

updateMask string (FieldMask format)

必要欄位。要更新的欄位清單。目前僅支援更新 customMetadata 和 data。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

方法：corpora.documents.chunks.batchDelete

批次刪除 Chunk。

端點

則貼文 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete 。

路徑參數

parent string

選用設定。包含要刪除的 Chunk 的 Document 名稱。每個 DeleteChunkRequest 中的父項欄位都必須與這個值相符。範例：corpora/my-corpus-123/documents/the-doc-abc 的格式為 corpora/{corpora}/documents/{document}。

要求主體

要求主體的資料會採用以下結構：

欄位
requests[] object (DeleteChunkRequest)

必要欄位。指定要刪除的 Chunk 的要求訊息。

回應主體

如果成功，回應主體會是空白的。

DeleteChunkRequest

要求刪除 Chunk。

JSON 表示法 
{
  "name": string
}
欄位
name string

必要欄位。要刪除的 Chunk 資源名稱。範例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk