REST Resource: projects.locations.collections.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 でのみ入力されます。

DocumentMetadata

ドキュメント メタデータには、現在のチャンクのドキュメントの情報が含まれます。

JSON 表現 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
フィールド
uri

string

ドキュメントの URI。
title

string

ドキュメントのタイトル。
mimeType

string

ドキュメントの MIME タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml。
structData

object (Struct format)

データ表現。ドキュメントの構造化 JSON データ。登録された Schema に準拠している必要があります。準拠していない場合は INVALID_ARGUMENT エラーがスローされます。

PageSpan

チャンクのページ範囲。

JSON 表現 
{
  "pageStart": integer,
  "pageEnd": integer
}
フィールド
pageStart

integer

チャンクの開始ページ。
pageEnd

integer

チャンクの終了ページ。

ChunkMetadata

現在のチャンクのメタデータ。このフィールドは、SearchService.Search API でのみ入力されます。

JSON 表現 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
フィールド
previousChunks[]

object (Chunk)

現在のチャンクの前のチャンク。この数は SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks によって制御されます。このフィールドは、SearchService.Search API でのみ入力されます。
nextChunks[]

object (Chunk)

現在のチャンクの次のチャンク。この数は SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks によって制御されます。このフィールドは、SearchService.Search API でのみ入力されます。

AnnotationMetadata

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

JSON 表現 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
フィールド
structuredContent

object (StructuredContent)

出力専用。構造化コンテンツの情報。
imageId

string

出力専用。構造化コンテンツが画像に基づいている場合は、画像 ID が提供されます。

StructuredContent

構造化コンテンツの情報。

JSON 表現 
{
  "structureType": enum (StructureType),
  "content": string
}
フィールド
structureType

enum (StructureType)

出力専用。構造化コンテンツの構造タイプ。
content

string

出力専用。構造化コンテンツの内容。

StructureType

抽出できる構造化コンテンツのタイプを定義します。

列挙型
STRUCTURE_TYPE_UNSPECIFIED デフォルト値。
SHAREHOLDER_STRUCTURE 株主構成。
SIGNATURE_STRUCTURE 署名構造。
CHECKBOX_STRUCTURE チェックボックスの構造。

メソッド

get

 Document を取得します。

list

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