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

リソース: ドキュメント

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

JSON 表現 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
フィールド
name

string

変更不可。ドキュメントの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}。

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

string

変更不可。ドキュメントの識別子。

ID は RFC-1034 標準に準拠し、長さの上限は 128 文字です。
schemaId

string

同じデータストアにあるスキーマの ID。
content

object (Content)

このドキュメントにリンクされている非構造化データ。このドキュメントが CONTENT_REQUIRED データストアにある場合、コンテンツは設定可能であり、設定する必要があります。
parentDocumentId

string

親ドキュメントの識別子。現在、最大 2 レベルのドキュメント階層がサポートされています。

ID は RFC-1034 標準に準拠し、長さは 63 文字以内にする必要があります。
derivedStructData

object (Struct format)

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

object (AclInfo)

ドキュメントのアクセス制御情報。
indexTime

string (Timestamp format)

出力専用。ドキュメントが最後にインデックスに登録された時刻。このフィールドが設定されている場合、ドキュメントが検索結果で返される可能性があります。

このフィールドは OUTPUT_ONLY です。このフィールドが入力されていない場合、ドキュメントは一度もインデックスに登録されていません。

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

object (IndexStatus)

出力専用。ドキュメントのインデックス ステータス。

  • ドキュメントが正常にインデックスに登録されると、indexTime フィールドにデータが入力されます。
  • それ以外の場合、エラーによりドキュメントがインデックスに登録されていないと、errorSamples フィールドにデータが入力されます。
  • それ以外の場合、ドキュメントのインデックス作成が進行中であれば、pendingMessage フィールドに値が入力されます。
共用体フィールド data。データ表現。struct_data または json_data のいずれかを指定する必要があります。指定しないと、INVALID_ARGUMENT エラーがスローされます。data は次のいずれかになります。
structData

object (Struct format)

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

string

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

メソッド

create

 Document を作成します。

delete

 Document を削除します。

get

 Document を取得します。

getProcessedDocument

 Document の解析済みレイアウト情報を取得します。

import

 複数の Document の一括インポート。

list

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

patch

 Document を更新します。

purge

 ブランチ内の選択したすべての Document を完全に削除します。