SearchSpec

検索の仕様。

JSON 表現 
{

  // Union field input can be only one of the following:
  "searchParams": {
    object (SearchParams)
  },
  "searchResultList": {
    object (SearchResultList)
  }
  // End of list of possible types for union field input.
}
Fields
共用体フィールド input。検索動作を制御する検索パラメータ。または、検索結果のリストを提供して回答を生成します。input は次のいずれかになります。
searchParams

object (SearchParams)

検索パラメータ。
searchResultList

object (SearchResultList)

検索結果のリスト。

SearchParams

検索パラメータ。

JSON 表現 
{
  "maxReturnResults": integer,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "orderBy": string,
  "searchResultMode": enum (SearchResultMode),
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  }
}
フィールド
maxReturnResults

integer

返す検索結果の数。デフォルト値は 10 です。
filter

string

フィルタ構文は、フィルタ対象となるドキュメントの 1 つ以上のフィールドから述語を生成するための式言語で構成されます。フィルタ式では大文字と小文字が区別されます。これは検索結果をフィルタリングするために使用され、回答のレスポンスに影響する可能性があります。

このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。

Vertex AI Search でのフィルタリングは、LHS フィルタキーを Vertex AI Search バックエンドで定義されたキー プロパティにマッピングすることによって行われます。このマッピングは、スキーマでユーザーが定義します。たとえば、メディアのお客様のスキーマには「name」というフィールドがある場合があります。この場合、フィルタは filter --> name:'ANY("king kong")' のようになります。

構文やフィルタ オペレータなどのフィルタリングの詳細については、フィルタをご覧ください。
boostSpec

object (BoostSpec)

検索結果で特定のドキュメントをブーストするブースト仕様。これにより、回答クエリ レスポンスに影響する可能性があります。ブーストの詳細については、ブーストをご覧ください。
orderBy

string

ドキュメントが返される順序。ドキュメントは、Document オブジェクトのフィールドで並べ替えることができます。関連性で並べ替える場合は、設定しないままにします。orderBy 式では大文字と小文字が区別されます。順序指定の詳細については、順序指定をご覧ください。

このフィールドが認識できない場合、INVALID_ARGUMENT が返されます。
searchResultMode

enum (SearchResultMode)

検索結果モードを指定します。指定しない場合、検索結果モードはデフォルトで DOCUMENTS になります。ドキュメントを解析してチャンクするをご覧ください。
dataStoreSpecs[]

object (DataStoreSpec)

検索呼び出しでフィルタする dataStore を定義する仕様と、それらの dataStore の構成。これは、複数のデータストアを使用するユースケースのエンジンでのみ考慮されます。エンジン内の単一のデータストアの場合、最上位の仕様を使用する必要があります。
naturalLanguageQueryUnderstandingSpec

object (NaturalLanguageQueryUnderstandingSpec)

省略可。検索リクエストの自然言語理解機能を有効にするための仕様。

SearchResultList

検索結果のリスト。

JSON 表現 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
フィールド
searchResults[]

object (SearchResult)

検索結果。

SearchResult

検索結果。

JSON 表現 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  }
  // End of list of possible types for union field content.
}
Fields
共用体フィールド content。検索結果のコンテンツ。content は次のいずれかになります。
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

非構造化ドキュメント情報。
chunkInfo

object (ChunkInfo)

チャンク情報。

UnstructuredDocumentInfo

非構造化ドキュメント情報。

JSON 表現 
{
  "document": string,
  "uri": string,
  "title": string,
  "documentContexts": [
    {
      object (DocumentContext)
    }
  ],
  "extractiveSegments": [
    {
      object (ExtractiveSegment)
    }
  ],
  "extractiveAnswers": [
    {
      object (ExtractiveAnswer)
    }
  ]
}
フィールド
document

string

ドキュメントのリソース名。
uri

string

ドキュメントの URI。
title

string

特徴があります
documentContexts[]

object (DocumentContext)

ドキュメント コンテキストのリスト。このコンテンツは回答の生成に使用されます。これは、長くて包括的なドキュメントのメイン コンテンツになるはずです。
extractiveSegments[]

object (ExtractiveSegment)

抽出セグメントのリスト。
extractiveAnswers[]
(deprecated)

object (ExtractiveAnswer)

非推奨: このフィールドは非推奨であり、回答の生成には影響しません。documentContexts フィールドと extractiveSegments フィールドを使用してください。抽出回答のリスト。

DocumentContext

ドキュメントのコンテキスト。

JSON 表現 
{
  "pageIdentifier": string,
  "content": string
}
フィールド
pageIdentifier

string

ページ ID。
content

string

回答の生成に使用するドキュメントのコンテンツ。

ExtractiveSegment

抽出セグメント。ガイド: documentContexts が空の場合にのみ、回答の生成に使用されます。これは短いスニペットを想定しています。

JSON 表現 
{
  "pageIdentifier": string,
  "content": string
}
フィールド
pageIdentifier

string

ページ ID。
content

string

抽出セグメントのコンテンツ。

ExtractiveAnswer

抽出回答。ガイド

JSON 表現 
{
  "pageIdentifier": string,
  "content": string
}
フィールド
pageIdentifier

string

ページ ID。
content

string

抽出回答の内容。

ChunkInfo

チャンク情報。

JSON 表現 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
フィールド
chunk

string

チャンク リソース名。
content

string

テキスト コンテンツをチャンク化します。
documentMetadata

object (DocumentMetadata)

現在のチャンクのドキュメントのメタデータ。

DocumentMetadata

ドキュメント メタデータには、現在のチャンクのドキュメントの情報が含まれます。

JSON 表現 
{
  "uri": string,
  "title": string
}
フィールド
uri

string

ドキュメントの URI。
title

string

ドキュメントのタイトル。