ContentSearchSpec

コンテンツ検索の動作を構成するための仕様。

JSON 表現 
{
  "snippetSpec": {
    object (SnippetSpec)
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "extractiveContentSpec": {
    object (ExtractiveContentSpec)
  },
  "searchResultMode": enum (SearchResultMode),
  "chunkSpec": {
    object (ChunkSpec)
  }
}
フィールド
snippetSpec

object (SnippetSpec)

snippetSpec が指定されていない場合、スニペットは検索レスポンスに含まれません。
summarySpec

object (SummarySpec)

summarySpec が指定されていない場合、検索レスポンスに概要は含まれません。
extractiveContentSpec

object (ExtractiveContentSpec)

extractiveContentSpec が指定されていない場合、検索レスポンスに抽出回答は含まれません。
searchResultMode

enum (SearchResultMode)

検索結果モードを指定します。指定しない場合、検索結果モードはデフォルトで DOCUMENTS になります。
chunkSpec

object (ChunkSpec)

検索レスポンスから返されるチャンク仕様を指定します。SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合にのみ使用できます。

SnippetSpec

検索レスポンスでスニペットを構成するための仕様。

JSON 表現 
{
  "maxSnippetCount": integer,
  "referenceOnly": boolean,
  "returnSnippet": boolean
}
フィールド
maxSnippetCount
(deprecated)

integer

[非推奨] このフィールドは非推奨になりました。スニペットの戻りを制御するには、returnSnippet フィールドを使用します。下位互換性を維持するため、maxSnippetCount > 0 の場合はスニペットを返します。
referenceOnly
(deprecated)

boolean

[非推奨] このフィールドは非推奨であり、スニペットには影響しません。
returnSnippet

boolean

true の場合は、スニペットを返します。スニペットを生成できない場合は、「このページのスニペットはありません」と返します。SUCCESS または NO_SNIPPET_AVAILABLE を含む snippetStatus も返されます。

ExtractiveContentSpec

検索レスポンスで抽出コンテンツを構成するための仕様。

JSON 表現 
{
  "maxExtractiveAnswerCount": integer,
  "maxExtractiveSegmentCount": integer,
  "returnExtractiveSegmentScore": boolean,
  "numPreviousSegments": integer,
  "numNextSegments": integer
}
フィールド
maxExtractiveAnswerCount

integer

各検索結果で返される抽出回答の最大数。

抽出回答は、元のドキュメントから抽出された逐語的な回答であり、検索クエリに対する正確で文脈的に関連性の高い回答を提供します。

一致する回答の数が maxExtractiveAnswerCount 未満の場合は、すべての回答を返します。それ以外の場合は、maxExtractiveAnswerCount を返します。

各 SearchResult に対して最大 5 つの回答が返されます。
maxExtractiveSegmentCount

integer

各検索結果で返される抽出セグメントの最大数。DataStore が DataStore.ContentConfig.CONTENT_REQUIRED に設定されている場合、または DataStore.solution_types が SOLUTION_TYPE_CHAT の場合にのみ適用されます。

抽出セグメントは、検索クエリに関連する元のドキュメントから抽出されたテキスト セグメントです。通常、抽出回答よりも冗長です。このセグメントは、LLM の入力として使用して、要約や回答を生成できます。

一致するセグメントの数が maxExtractiveSegmentCount より少ない場合は、すべてのセグメントを返します。それ以外の場合は、maxExtractiveSegmentCount を返します。
returnExtractiveSegmentScore

boolean

各検索結果の抽出セグメントから信頼スコアを返すかどうかを指定します。この機能は、新しいデータストアまたは許可リストに登録されたデータストアでのみ使用できます。データストアを許可リストに登録するには、カスタマー エンジニアにお問い合わせください。デフォルト値は false です。
numPreviousSegments

integer

選択した各セグメントの隣接するセグメントも含むかどうかを指定します。選択した各セグメントの前に最大 numPreviousSegments 個のセグメントを返します。
numNextSegments

integer

選択した各セグメントの後に最大 numNextSegments 個のセグメントを返します。

ChunkSpec

検索レスポンスから返されるチャンク仕様を指定します。SearchRequest.ContentSearchSpec.search_result_mode が CHUNKS に設定されている場合にのみ使用できます。

JSON 表現 
{
  "numPreviousChunks": integer,
  "numNextChunks": integer
}
フィールド
numPreviousChunks

integer

現在のチャンクの前のチャンクの数。最大値は 3 です。指定しない場合、以前のチャンクは返されません。
numNextChunks

integer

現在のチャンクから返される次のチャンクの数。最大値は 3 です。指定しない場合、次のチャンクは返されません。