Chunks

方法：corpora.documents.chunks.create

建立 Chunk。

端點

post 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 的例項。

欄位
name string

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

data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

回應主體

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

方法：corpora.documents.chunks.list

列出 Document 中的所有 Chunk。

端點

get 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 的相關資訊。

端點

get 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 個字元，只能使用小寫英數字元或連字號 (-)，開頭或結尾不得為連字號。如果建立時名稱為空白，系統會隨機產生 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 的例項。

欄位
data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

回應主體

如果成功，回應主體會包含 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}。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會是空的 JSON 物件。

方法：corpora.documents.chunks.batchCreate

批次建立 Chunk。

端點

post 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 的要求。

欄位
parent string

必要欄位。這個 Chunk 將會建立在哪個 Document 中。範例：corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

必要欄位。要建立的 Chunk。

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

方法：corpora.documents.chunks.batchUpdate

批次更新 Chunk。

端點

post 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)

必要欄位。指定要更新的 Chunk 要求訊息。一次最多只能更新 100 個 Chunk。

回應主體

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

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

欄位
chunks[] object (Chunk)

已更新 Chunk。

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

UpdateChunkRequest

更新 Chunk 的要求。

欄位
chunk object (Chunk)

必要欄位。要更新的 Chunk。

updateMask string (FieldMask format)

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

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

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

方法：corpora.documents.chunks.batchDelete

批次刪除 Chunk。

端點

post 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 要求訊息。

回應主體

如果成功，回應主體會是空的 JSON 物件。

DeleteChunkRequest

要求刪除 Chunk。

欄位
name string

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

JSON 表示法 
{
  "name": string
}

REST 資源：corpora.documents.chunks

資源：Chunk

Chunk 是 Document 的子部分，會視為向量表示法和儲存空間的獨立單元。Corpus 最多可包含 100 萬個 Chunk。

欄位
name string

不可變動。ID。Chunk 資源名稱。ID (名稱不含「corpora/*/documents/*/chunks/」前置字串) 最多可包含 40 個字元，只能使用小寫英數字元或連字號 (-)，開頭或結尾不得為連字號。如果建立時名稱為空白，系統會隨機產生 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 建立時間的時間戳記。

使用 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)

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

使用 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"。

state enum (State)

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

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

ChunkData

代表 Chunk 內容的擷取資料。

欄位
data Union type
data 只能是下列其中一項：
stringValue string

Chunk 內容為字串。每個區塊的符記數量上限為 2043 個。

JSON 表示法 
{

  // data
  "stringValue": string
  // Union type
}

州

Chunk 生命週期的狀態。

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