REST Resource: projects.locations.dataStores.branches.documents.chunks

リソース: チャンク

チャンクは、チャンクモードで推奨または検索されるアイテムのすべての未加工のメタデータ情報をキャプチャします。

JSON 表現 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
フィールド
name

string

チャンクの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
id

string

現在のチャンクの一意のチャンク ID。
content

string

コンテンツはドキュメントの文字列（解析されたコンテンツ）です。
documentMetadata

object (DocumentMetadata)

現在のチャンクのドキュメントのメタデータ。
derivedStructData

object (Struct format)

出力専用。このフィールドは OUTPUT_ONLY です。元の入力ドキュメントにはない派生データが含まれています。
pageSpan

object (PageSpan)

チャンクのページ範囲。
chunkMetadata

object (ChunkMetadata)

出力専用。現在のチャンクのメタデータ。
dataUrls[]

string

出力専用。現在のチャンクに画像が含まれている場合は、画像データ URL。データ URL は、接頭辞（data:）、データのタイプを示す MIME タイプ、テキスト以外の場合はオプションの base64 トークン、データ自体の 4 つの部分で構成されます。data:[][;base64],
annotationContents[]

string

出力専用。現在チャンクにアノテーションが含まれている場合のアノテーションの内容。
annotationMetadata[]

object (AnnotationMetadata)

出力専用。アノテーション メタデータには、現在のチャンクの構造化コンテンツが含まれます。
relevanceScore

number

出力専用。類似性に基づく関連性スコアを表します。スコアが高いほど、チャンクの関連性が高いことを示します。スコアの範囲は [-1.0, 1.0] です。SearchResponse でのみ入力されます。

メソッド

get

 Document を取得します。

list

 Chunk のリストを取得します。