単一の DataStore のドキュメントを検索します。
ランク付けされたサブドキュメント セグメントを返します。各セグメントは、元のドキュメントを参照し、引用に必要な出所情報を含んでいます。
HTTP リクエスト
POST https://vectorsearch.googleapis.com/v1beta/{parent}/documents:search
パスパラメータ
| パラメータ | |
|---|---|
parent |
必須。検索する DataStore。形式: |
リクエストの本文
リクエストの本文には、次の構造のデータが含まれます。
| JSON 表現 |
|---|
{ "topK": integer, "documentIds": [ string ], "rankingSpec": { object ( |
| フィールド | |
|---|---|
topK |
省略可。返される結果の数。デフォルトは 10 です。100 を超える値は 100 に強制変換されます。 |
documentIds[] |
省略可。検索をこれらのドキュメント ID に制限します。最大 100。空の場合、DataStore 全体が検索されます。 |
rankingSpec |
省略可。結果のランク付け方法を制御します。 |
filter |
省略可。検索をこのフィルタに一致するセグメントに制限します。これは、
比較: {"$and": [{"metadata.year": {"$gte": 2025}}, {"unstructured_details.page_range.start_page": {"$lte": 20}}]} |
outputFields |
省略可。各結果で返されるフィールド。 |
| 必須。検索するクエリ。クエリタイプは 1 つだけ設定する必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
textQuery |
テキストクエリ。 |
| 相互に排他的なフィールドの終了。 | |
レスポンスの本文
DocumentSearchService.SearchDocuments に対するレスポンス メッセージです。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
|---|
{ "results": [ { object ( |
| フィールド | |
|---|---|
results[] |
出力専用。検索条件に一致するドキュメント セグメント。関連性の高い順に並べ替えられます。 |
warnings[] |
出力専用。実行中に発生した警告または致命的でないエラー。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/vectorsearchhttps://www.googleapis.com/auth/vectorsearch.readonly
詳細については、Authentication Overview をご覧ください。
TextQuery
テキストクエリ。
| JSON 表現 |
|---|
{ "text": string } |
| フィールド | |
|---|---|
text |
必須。検索するテキスト。 |
RankingSpec
結果のランク付け方法を制御します。
| JSON 表現 |
|---|
{
"rerankingSpec": {
object ( |
| フィールド | |
|---|---|
rerankingSpec |
省略可。再ランキング ステージを制御します。 |
RerankingSpec
ハイブリッド検索と Reciprocal Rank Fusion(RRF)の後に候補結果に適用されるセマンティック再ランキングの構成。
| JSON 表現 |
|---|
{ "enabled": boolean, "rankOversamplingFactor": integer } |
| フィールド | |
|---|---|
enabled |
省略可。融合された結果を再ランク付けするかどうか。デフォルトは false です。呼び出し元がオプトインしない限り、結果は RRF 融合順で返されます。 有効にすると、再ランキングは Vertex Ranking Service で
|
rankOversamplingFactor |
省略可。再ランキング前に候補をオーバーサンプリングする係数。再ランキングのために取得された候補の合計数は
オーバーサンプリングなしで再ランク付けするには、このフィールドを 1 に設定します。 |
OutputFields
すべての結果に含まれるフィールドに加えて、各 DocumentSearchResult で返されるフィールド。
| JSON 表現 |
|---|
{ "metadata": [ string ] } |
| フィールド | |
|---|---|
metadata[] |
省略可。 |
DocumentSearchResult
ドキュメントの一致する単一のセグメント。
| JSON 表現 |
|---|
{ "document": { object ( |
| フィールド | |
|---|---|
document |
出力専用。このセグメントの取得元であるドキュメント(リソース名と、取り込み元の Cloud Storage のロケーションを含む)。 すべての Document フィールドが入力されるわけではありません。完全なドキュメントを取得するには、返されたドキュメント名に対して documents.get を呼び出します。 |
ドキュメント内のセグメントの位置の詳細。設定されるフィールドは、親 DataStore の document_type に従います。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 |
|
videoDetails |
親 DataStore の |
unstructuredDetails |
親 DataStore の |
| 相互に排他的なフィールドの終了。 | |
VideoSegmentDetails
動画ドキュメント内のセグメントを特定します。
| JSON 表現 |
|---|
{ "startOffset": string, "endOffset": string } |
| フィールド | |
|---|---|
startOffset |
出力専用。このセグメントの開始位置(ソース動画の開始位置を基準とする)。
|
endOffset |
出力専用。このセグメントの終了位置(ソース動画の開始位置を基準とする)。
|
UnstructuredSegmentDetails
非構造化ドキュメント内のセグメントを特定し、そのテキストを保持します。
| JSON 表現 |
|---|
{
"contentSnippet": string,
"pageRange": {
object ( |
| フィールド | |
|---|---|
contentSnippet |
出力専用。セグメントのテキスト コンテンツ。 |
pageRange |
出力専用。ソース ドキュメント内のセグメントの位置。PDF、PowerPoint、Excel ファイルに設定します。ページは PDF ページ、スライド、シートです。HTML、書式なしテキスト、Markdown、JSON、XML、Word ファイルの場合、ファイルがページに分割されている場合にのみ設定します(デジタル解析を使用した |
PageRange
ソース ドキュメント内のページ範囲。ページは 1 から始まり、範囲は包括的です。1 ページは startPage == endPage として表されます。
| JSON 表現 |
|---|
{ "startPage": string, "endPage": string } |
| フィールド | |
|---|---|
startPage |
出力専用。範囲の最初のページ。 |
endPage |
出力専用。範囲の最後のページ。 |