REST Resource: corpora.documents

リソース: ドキュメント

Document は Chunk の集合です。1 つの Corpus に設定できる Document は 10,000 個までです。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
フィールド
name

string

変更不可。ID。Document リソース名。ID（接頭辞「corpora/*/documents/」を除く名前）は最大 40 文字で、小文字の英数字またはダッシュ（-）を使用できます。ID の先頭と末尾をダッシュにすることはできません。作成時に名前が空の場合、displayName から、12 文字のランダムなサフィックスが付加された一意の名前が生成されます。例: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName

string

（省略可）Document の人が読める形式の表示名。表示名は、スペースを含めて 512 文字以下にする必要があります。例: 「セマンティック レトリーバーのドキュメント」
customMetadata[]

object (CustomMetadata)

（省略可）ユーザー提供のカスタム メタデータがクエリに使用する Key-Value ペアとして保存される。Document には最大 20 個の CustomMetadata を指定できます。
updateTime

string (Timestamp format)

出力のみ。Document が最後に更新されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

出力のみ。Document が作成された時点のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

Methods

create

 空の Document を作成します。

delete

 Document を削除します。

get

 特定の Document に関する情報を取得します。

list

 Corpus 内のすべての Document を一覧表示します。

patch

 Document を更新します。

query

 Document に対してセマンティック検索を実行します。