REST Resource: projects.locations.dataStores.documents

リソース: Document

ドキュメントは、DataStore に取り込まれるコンテンツの単一ユニットです。これは DataStore のサブリソースです。取り込み時に、ドキュメントが解析され、1 つ以上のセグメントにチャンク化されます。

JSON 表現 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
フィールド
name

string

ID。ドキュメントの完全修飾リソース名。

形式: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId}。documentId は 1 ～ 63 文字で、RFC1035 に準拠している必要があります。

ImportDocuments がファイルを直接インポートする場合（デフォルトのソース形式）、サービスはファイルの Cloud Storage URI から documentId を取得します。同じ URI を再インポートすると、同じドキュメントが更新され、名前が変更されたファイルまたは移動されたファイルは新しいドキュメントになります。SOURCE_FORMAT_DOCUMENT_JSON の場合、documentId は入力ファイルで指定された name から取得されます。
createTime

string (Timestamp format)

出力専用。ドキュメントが作成されたときのタイムスタンプ。

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)

出力専用。ドキュメントが最後に更新されたときのタイムスタンプ。

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"。
content

object (Content)

省略可。このドキュメントにリンクされている非構造化データ。インポート元の Cloud Storage ファイル。SOURCE_FORMAT_DOCUMENT_JSON 入力ファイルの各行で必須です。
etag

string

省略可。ドキュメントの etag。
metadata

object (DocumentMetadata)

省略可。このドキュメントのユーザー定義のメタデータ。メタデータ値は、親 DataStore で定義された documentMetadataSchema に準拠している必要があります。

コンテンツ

このドキュメントにリンクされている非構造化データ。

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
フィールド
非構造化ドキュメントのコンテンツ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
gcsUri

string

コンテンツの Cloud Storage URI。Cloud Storage URI（gs://bucket-name/path/to/file など）のみがサポートされています。
相互に排他的なフィールドの終了。

DocumentMetadata

ドキュメントに関連付けられたユーザー定義のメタデータ。

JSON 表現 
{
  "value": {
    object
  }
}
フィールド
value

object (Struct format)

省略可。メタデータ値（JSON オブジェクト）。値は、親 DataStore で定義された documentMetadataSchema に準拠している必要があります。

メソッド

get

 Document を取得します。

list

 DataStore 内のドキュメントを一覧表示します。
単一の DataStore のドキュメントを検索します。