Docuents

REST リソース: corpora.documents

リソース: ドキュメント

Document は Chunk の集合です。Corpus には、最大 10,000 個の Document を指定できます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
<ph type="x-smartling-placeholder">
</ph> フィールド
name string

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

displayName string

省略可。Document の人が読める形式の表示名。表示名の長さは、スペースを含めて 512 文字以下にする必要があります。例: 「Semantic Retriever のドキュメント」

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

メソッド: corpora.documents.create

空の Document を作成します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

パスパラメータ

parent string

必須。この Document が作成される Corpus の名前。例: corpora/my-corpus-123 corpora/{corpora} の形式になります。

リクエスト本文

リクエストの本文には Document のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Document のインスタンスが含まれます。

メソッド: corpora.documents.list

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

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

パスパラメータ

parent string

必須。Document を含む Corpus の名前。例: corpora/my-corpus-123 corpora/{corpora} の形式になります。

クエリ パラメータ

pageSize integer

省略可。返される Document の最大数（1 ページあたり）。サービスは、返される Document の数が少なくなる場合があります。

指定しない場合、最大で 10 個の Document が返されます。サイズの上限は 1 ページあたり 20 Document です。

pageToken string

省略可。前回の documents.list 呼び出しから受け取ったページトークン。

次のページを取得するには、レスポンスで返された nextPageToken を次のリクエストの引数として指定します。

ページ分割を行う場合、documents.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Document のページ分けされたリストを含む documents.list からのレスポンス。Document は document.create_time の昇順で並べ替えられます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
documents[] object (Document)

返された Document。

nextPageToken string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、ページがなくなります。

JSON 表現 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

メソッド: corpora.documents.query

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

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

パスパラメータ

name string

必須。クエリする Document の名前。例: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
query string

必須。セマンティック検索を行うためのクエリ文字列。

resultsCount integer

省略可。返される Chunk の最大数。サービスは、返される Chunk の数が少なくなる場合があります。

指定しない場合、最大で 10 個の Chunk が返されます。指定できる結果の最大数は 100 です。

metadataFilters[] object (MetadataFilter)

省略可。Chunk メタデータをフィルタします。各 MetadataFilter オブジェクトは一意のキーに対応している必要があります。複数の MetadataFilter オブジェクトは論理「AND」で結合されます。

注: Document 名がすでに指定されているため、このリクエストでは Document レベルのフィルタリングはサポートされていません。

クエリの例: (年 >= 2020 OR 年 < 2010) AND (ジャンル = ドラマ OR ジャンル = アクション)

MetadataFilter オブジェクト リスト: metadataFilters = [ {key = "chunk.custom_metadata.year"conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre"conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

数値範囲に対するクエリの例: (year > 2015 AND year <= 2020)

MetadataFilter オブジェクト リスト: metadataFilters = [ {key = "chunk.custom_metadata.year"conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot;conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

注: 同じキーに対する「AND」は数値に対してのみサポートされています。文字列値の場合、同じキーに対して「OR」のみ使用できます。

レスポンスの本文

関連するチャンクのリストを含む documents.query からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
relevantChunks[] object (RelevantChunk)

返された関連するチャンク。

JSON 表現 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

メソッド: corpora.documents.get

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

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

パスパラメータ

name string

必須。取得する Document の名前。例: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} の形式になります。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Document のインスタンスが含まれます。

メソッド: corpora.documents.patch

Document を更新します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> パッチ https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

パスパラメータ

document.name string

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

クエリ パラメータ

updateMask string (FieldMask format)

必須。更新するフィールドのリスト。現在、これは displayName と customMetadata の更新のみをサポートしています。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Document のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Document のインスタンスが含まれます。

メソッド: corpora.documents.delete

Document を削除します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 削除 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

パスパラメータ

name string

必須。削除する Document のリソース名。例: corpora/my-corpus-123/documents/the-doc-abc corpora/{corpora}/documents/{document} の形式になります。

クエリ パラメータ

force boolean

省略可。true に設定すると、この Document に関連する Chunk とオブジェクトも削除されます。

false（デフォルト）の場合、Document に Chunk が含まれていると、FAILED_PRECONDITION エラーが返されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

CustomMetadata

Key-Value ペアとして保存されているユーザー提供のメタデータ。

JSON 表現 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
<ph type="x-smartling-placeholder">
</ph> フィールド
key string

必須。保存するメタデータのキー。

共用体フィールド value。

value は次のいずれかになります。

stringValue string

保存するメタデータの文字列値。

stringListValue object (StringList)

保存するメタデータの StringList 値。

numericValue number

保存するメタデータの数値。

StringList

単一のメタデータキーに割り当てられたユーザー指定の文字列値。

JSON 表現 
{
  "values": [
    string
  ]
}
<ph type="x-smartling-placeholder">
</ph> フィールド
values[] string

保存するメタデータの文字列値。