REST Resource: 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 のコンテンツ。チャンクあたりのトークンの最大数は 2,043 です。
customMetadata[]

object (CustomMetadata)

（省略可）ユーザー提供のカスタム メタデータを Key-Value ペアとして保存。チャンクあたりの CustomMetadata の最大数は 20 です。
createTime

string (Timestamp format)

出力のみ。Chunk が作成された時点のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力のみ。Chunk が最後に更新されたときのタイムスタンプ。

RFC3339 UTC「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 のコンテンツ（文字列）。チャンクあたりのトークンの最大数は 2,043 です。

状態

Chunk のライフサイクルの状態。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は、状態を省略する場合に使用されます。
STATE_PENDING_PROCESSING Chunk を処理しています（エンベディングとベクトル ストレージ）。
STATE_ACTIVE Chunk が処理され、クエリに使用できるようになります。
STATE_FAILED Chunk を処理できませんでした。

Methods

batchCreate

 Chunk を一括作成します。

batchDelete

 Chunk を一括削除します。

batchUpdate

 Chunk のバッチ アップデート。

create

 Chunk を作成します。

delete

 Chunk を削除します。

get

 特定の Chunk に関する情報を取得します。

list

 Document 内のすべての Chunk を一覧表示します。

patch

 Chunk を更新します。