Chunks

REST リソース: 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)
}
<ph type="x-smartling-placeholder">
</ph> フィールド
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.
}
<ph type="x-smartling-placeholder">
</ph> フィールド

共用体フィールド data。

data は次のいずれかになります。

stringValue string

文字列としての Chunk コンテンツ。チャンクあたりのトークンの最大数は 2,043 です。

州

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

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

メソッド: corpora.documents.chunks.create

Chunk を作成します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 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 を一覧表示します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 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 の最大数（1 ページあたり）。サービスは、返される Chunk の数が少なくなる場合があります。

指定しない場合、最大で 10 個の Chunk が返されます。サイズの上限は、1 ページあたり 100 Chunk です。

pageToken string

省略可。前回の chunks.list 呼び出しから受け取ったページトークン。

次のページを取得するには、レスポンスで返された nextPageToken を次のリクエストの引数として指定します。

ページ分割を行う場合、chunks.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Chunk のページ分けされたリストを含む chunks.list からのレスポンス。Chunk は chunk.create_time の昇順で並べ替えられます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
chunks[] object (Chunk)

返された Chunk。

nextPageToken string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、ページがなくなります。

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

メソッド: corpora.documents.chunks.get

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

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 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 を更新します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> パッチ 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 を削除します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 削除 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 を一括作成します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 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} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
requests[] object (CreateChunkRequest)

必須。作成する Chunk を指定するリクエスト メッセージ。1 つのバッチで作成できる Chunk は最大 100 個です。

レスポンスの本文

作成された Chunk のリストを含む chunks.batchCreate からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
chunks[] object (Chunk)

Chunk を作成しました。

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

CreateChunkRequest

Chunk の作成をリクエストします。

JSON 表現 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
<ph type="x-smartling-placeholder">
</ph> フィールド
parent string

必須。この Chunk が作成される Document の名前。例: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

必須。作成する Chunk。

メソッド: corpora.documents.chunks.batchUpdate

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

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 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} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
requests[] object (UpdateChunkRequest)

必須。更新する Chunk を指定するリクエスト メッセージ。一度に最大 100 個の Chunk を更新できます。

レスポンスの本文

更新された Chunk のリストを含む chunks.batchUpdate からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
chunks[] object (Chunk)

Chunk を更新しました。

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

UpdateChunkRequest

Chunk の更新をリクエストします。

JSON 表現 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
<ph type="x-smartling-placeholder">
</ph> フィールド
chunk object (Chunk)

必須。更新する Chunk。

updateMask string (FieldMask format)

必須。更新するフィールドのリスト。現在、これは customMetadata と data の更新のみをサポートしています。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

メソッド: corpora.documents.chunks.batchDelete

Chunk を一括削除します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 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} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
requests[] object (DeleteChunkRequest)

必須。削除する Chunk を指定するリクエスト メッセージ。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

DeleteChunkRequest

Chunk の削除をリクエストします。

JSON 表現 
{
  "name": string
}
<ph type="x-smartling-placeholder">
</ph> フィールド
name string

必須。削除する Chunk のリソース名。例: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk