Chunks

メソッド: 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 のインスタンスが含まれます。

フィールド
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 です。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された 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 に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

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

レスポンスの本文

Chunk のページネーション付きリストを含む chunks.list からのレスポンス。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 文字まで含めることができます。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 のインスタンスが含まれます。

フィールド
data object (ChunkData)

必須。Chunk のコンテンツ（テキスト文字列など）。チャンクあたりのトークンの最大数は 2,043 です。

customMetadata[] object (CustomMetadata)

省略可。ユーザー提供のカスタム メタデータは Key-Value ペアとして保存されます。チャンクあたりの 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 を一括作成します。

エンドポイント

投稿 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 を指定するリクエスト メッセージ。バッチで作成できる Chunk は最大 100 個です。

レスポンスの本文

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

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

フィールド
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 を一括更新します。

エンドポイント

投稿 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 を指定するリクエスト メッセージ。バッチで更新できる Chunk は最大 100 個です。

レスポンスの本文

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

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

フィールド
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 を一括削除します。

エンドポイント

投稿 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 は、ベクトルの表現と保存のために独立した単位として扱われる Document のサブパートです。Corpus には最大 100 万個の Chunk を設定できます。

フィールド
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 が作成されたときのタイムスタンプ。

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

JSON 表現 
{

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

州

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

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