メソッド: corpora.documents.create
空の Document
を作成します。
エンドポイント
投稿https: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
parent
string
必須。この Document
が作成される Corpus
の名前。例: corpora/my-corpus-123
形式は corpora/{corpora}
です。
リクエストの本文
リクエストの本文には Document
のインスタンスが含まれます。
name
string
変更不可。ID。Document
リソース名。ID(「corpora/*/documents/」接頭辞を除く名前)には、小文字の英数字またはダッシュ(-)を 40 文字まで含めることができます。ID の先頭または末尾にダッシュを使用できません。作成時に名前が空の場合、displayName
から一意の名前が派生し、12 文字のランダムな接尾辞が付加されます。例: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
省略可。Document
の表示名(人が読める形式)。表示名は、スペースを含めて 512 文字以内にする必要があります。例: 「Semantic Retriever のドキュメント」
customMetadata[]
object (CustomMetadata
)
省略可。クエリに使用される Key-Value ペアとして保存される、ユーザー提供のカスタム メタデータ。Document
には最大 20 個の CustomMetadata
を含めることができます。
レスポンスの本文
成功した場合、レスポンスの本文には、新しく作成された Document
のインスタンスが含まれます。
メソッド: corpora.documents.query
Document
に対してセマンティック検索を実行します。
エンドポイント
投稿https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}:query
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
name
string
必須。クエリを実行する Document
の名前。例: corpora/my-corpus-123/documents/the-doc-abc
形式は corpora/{corpora}/documents/{document}
です。
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
query
string
必須。セマンティック検索を実行するクエリ文字列。
resultsCount
integer
省略可。返される Chunk
の最大数。サービスが返す Chunk
が少ないことがあります。
指定されていない場合は、最大で 10 個の Chunk
が返されます。指定できる結果の最大数は 100 です。
metadataFilters[]
object (MetadataFilter
)
省略可。Chunk
メタデータでフィルタします。各 MetadataFilter
オブジェクトは一意のキーに対応している必要があります。複数の MetadataFilter
オブジェクトは論理「AND」で結合されます。
注: Document
名がすでに指定されているため、このリクエストでは Document
レベルのフィルタリングはサポートされていません。
クエリの例: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
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 = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
注: 同じキーの「AND」は、数値に対してのみサポートされます。文字列値では、同じキーの「OR」のみがサポートされます。
レスポンスの本文
関連するチャンクのリストを含む documents.query
からのレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
relevantChunks[]
object (RelevantChunk
)
返された関連するチャンク。
JSON 表現 |
---|
{
"relevantChunks": [
{
object ( |
メソッド: corpora.documents.list
Corpus
内のすべての Document
を一覧表示します。
エンドポイント
gethttps: / /generativelanguage.googleapis.com /v1beta /{parent=corpora /*} /documents
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
parent
string
必須。Document
を含む Corpus
の名前。例: corpora/my-corpus-123
形式は corpora/{corpora}
です。
クエリ パラメータ
pageSize
integer
省略可。返される Document
の最大数(ページあたり)。サービスが返す Document
が少ないことがあります。
指定されていない場合は、最大で 10 個の Document
が返されます。最大サイズの上限は、ページあたり 20 個の Document
です。
pageToken
string
省略可。前回の documents.list
呼び出しから受け取ったページトークン。
レスポンスで返された nextPageToken
を次のリクエストの引数として指定して、次のページを取得します。
ページ分割を行う場合、documents.list
に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
Document
のページネーション付きリストを含む documents.list
からのレスポンス。Document
は document.create_time
の昇順で並べ替えられます。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
documents[]
object (Document
)
返された Document
。
nextPageToken
string
次のページを取得するために pageToken
として送信できるトークン。このフィールドを省略すると、それ以上ページはありません。
JSON 表現 |
---|
{
"documents": [
{
object ( |
メソッド: corpora.documents.get
特定の Document
に関する情報を取得します。
エンドポイント
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
name
string
必須。取得する Document
の名前。例: corpora/my-corpus-123/documents/the-doc-abc
形式は corpora/{corpora}/documents/{document}
です。
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功した場合、レスポンスの本文には Document
のインスタンスが含まれます。
メソッド: corpora.documents.patch
Document
を更新します。
エンドポイント
パッチhttps: / /generativelanguage.googleapis.com /v1beta /{document.name=corpora /* /documents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
document.name
string
変更不可。ID。Document
リソース名。ID(「corpora/*/documents/」接頭辞を除く名前)には、小文字の英数字またはダッシュ(-)を 40 文字まで含めることができます。ID の先頭または末尾にダッシュを使用できません。作成時に名前が空の場合、displayName
から一意の名前が派生し、12 文字のランダムな接尾辞が付加されます。例: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
形式は corpora/{corpora}/documents/{document}
です。
クエリ パラメータ
updateMask
string (FieldMask
format)
必須。更新するフィールドのリスト。現在、displayName
と customMetadata
の更新のみがサポートされています。
完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"
。
リクエストの本文
リクエストの本文には Document
のインスタンスが含まれます。
displayName
string
省略可。Document
の表示名(人が読める形式)。表示名は、スペースを含めて 512 文字以内にする必要があります。例: 「Semantic Retriever のドキュメント」
customMetadata[]
object (CustomMetadata
)
省略可。クエリに使用される Key-Value ペアとして保存される、ユーザー提供のカスタム メタデータ。Document
には最大 20 個の CustomMetadata
を含めることができます。
レスポンスの本文
成功した場合、レスポンスの本文には Document
のインスタンスが含まれます。
メソッド: corpora.documents.delete
Document
を削除します。
エンドポイント
削除https: / /generativelanguage.googleapis.com /v1beta /{name=corpora /* /documents /*}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
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
エラーが返されます。
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文は空の JSON オブジェクトになります。
REST リソース: corpora.documents
リソース: ドキュメント
Document
は Chunk
の集合です。Corpus
には最大 10,000 個の Document
を設定できます。
name
string
変更不可。ID。Document
リソース名。ID(「corpora/*/documents/」接頭辞を除く名前)には、小文字の英数字またはダッシュ(-)を 40 文字まで含めることができます。ID の先頭または末尾にダッシュを使用できません。作成時に名前が空の場合、displayName
から一意の名前が派生し、12 文字のランダムな接尾辞が付加されます。例: 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
が最後に更新されたときのタイムスタンプ。
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"
。
createTime
string (Timestamp
format)
出力専用。Document
が作成されたときのタイムスタンプ。
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"
。
JSON 表現 |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
CustomMetadata
ユーザー提供のメタデータは Key-Value ペアとして保存されます。
key
string
必須。保存するメタデータのキー。
value
Union type
value
は次のいずれかになります。stringValue
string
保存するメタデータの文字列値。
stringListValue
object (StringList
)
保存するメタデータの StringList 値。
numericValue
number
保存するメタデータの数値。
JSON 表現 |
---|
{
"key": string,
// value
"stringValue": string,
"stringListValue": {
object ( |
StringList
単一のメタデータキーに割り当てられたユーザー提供の文字列値。
values[]
string
保存するメタデータの文字列値。
JSON 表現 |
---|
{ "values": [ string ] } |