- リソース: Evaluation
- EvaluationSpec
- ImageQuery
- FacetSpec
- FacetKey
- Interval
- QueryExpansionSpec
- 条件
- SpellCorrectionSpec
- Mode
- EmbeddingSpec
- EmbeddingVector
- RankingExpressionBackend
- NaturalLanguageQueryUnderstandingSpec
- FilterExtractionCondition
- ExtractedFilterBehavior
- SearchAsYouTypeSpec
- 条件
- DisplaySpec
- MatchHighlightingCondition
- SessionSpec
- RelevanceThreshold
- RelevanceScoreSpec
- SearchAddonSpec
- QuerySetSpec
- QualityMetrics
- TopkMetrics
- 状態
- メソッド
リソース: Evaluation
評価とは、評価プロセスの 1 回の実行のことです。評価の状態と結果のデータをカプセル化します。
JSON 表現 |
---|
{ "name": string, "evaluationSpec": { object ( |
フィールド | |
---|---|
name |
ID。 このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。 |
evaluationSpec |
必須。評価の仕様。 |
qualityMetrics |
出力専用。評価によって生成された指標。 評価の状態が SUCCEEDED の場合にのみ入力されます。 |
state |
出力専用。評価の状態。 |
error |
出力専用。評価中に発生したエラー。評価の状態が FAILED の場合にのみ入力されます。 |
createTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
endTime |
出力専用。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
errorSamples[] |
出力専用。リクエストの処理中に発生したエラーのサンプル。 |
EvaluationSpec
評価の仕様を記述します。
JSON 表現 |
---|
{ "querySetSpec": { object ( |
フィールド | |
---|---|
querySetSpec |
省略可。クエリセットの仕様。 |
共用体フィールド search_spec 。検索仕様。search_spec は次のいずれかになります。 |
|
searchRequest |
必須。評価の実行に使用される検索リクエスト。 SearchRequest 内の次のフィールドのみがサポートされています。他のフィールドを指定すると、UNSUPPORTED エラーが返されます。 |
ImageQuery
画像クエリの入力を指定します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
imageBytes |
Base64 でエンコードされた画像バイト。サポートされている画像形式: JPEG、PNG、BMP。 |
FacetSpec
ファセット検索を実行するファセットの仕様。
JSON 表現 |
---|
{
"facetKey": {
object ( |
フィールド | |
---|---|
facetKey |
必須。ファセット キーの仕様。 |
limit |
このファセットに対して返されるファセット値の最大数。指定しない場合、デフォルトは 20 です。最大値は 300 です。300 を超える値は 300 に強制変換されます。医療検索の集計では、[FacetKey.key] が「healthcare_aggregation_key」の場合、ここで設定された値に関係なく、上限は内部的に 10,000 にオーバーライドされます。 このフィールドが負の数の場合、 |
excludedFilterKeys[] |
ファセット処理時に除外するキーのリスト。 デフォルトでは、このフィールドにリストされていない限り、 このフィールドにファセットキーを登録すると、検索結果から除外された場合でも、その値がファセット結果として表示されます。このフィールドを使用しても、返される検索結果には影響しません。 たとえば、色のファセット「赤」を含むドキュメントが 100 個、色のファセット「青」を含むドキュメントが 200 個あるとします。フィルタ「color:ANY("Red")」を含み、 「color」が「excludedFilterKeys」にリストされている場合、クエリはファセット値「Red」(カウント 100)と「Blue」(カウント 200)を返します。これは、「color」キーがフィルタから除外されたためです。このフィールドは検索結果に影響しないため、検索結果は引き続き正しくフィルタリングされ、「赤」のドキュメントのみが返されます。 最大 100 個の値を指定できます。それ以外の場合は、 |
enableDynamicPosition |
このファセットの動的位置を有効にします。true に設定すると、レスポンス内のすべてのファセットにおけるこのファセットの位置が自動的に決定されます。動的ファセットが有効になっている場合は、一緒に並べ替えられます。false に設定すると、レスポンスでのこのファセットの位置はリクエストでの位置と同じになり、動的ポジションが有効になっているファセットとすべての動的ファセットの前にランク付けされます。 たとえば、レスポンスで常に評価ファセットを返すようにしたいが、評価ファセットを常に上部に表示する必要はない場合があります。その場合は、enableDynamicPosition を true に設定して、レスポンス内の評価ファセットの位置を自動的に決定できます。 別の例として、リクエストに次のファセットがあるとします。
また、動的ファセットが有効になっているため、ファセット |
FacetKey
ファセットの計算方法を指定します。
JSON 表現 |
---|
{
"key": string,
"intervals": [
{
object ( |
フィールド | |
---|---|
key |
必須。 |
intervals[] |
値を区間に分類する場合にのみ設定します。数値を含むファセットに設定する必要があります。テキスト値を含むファセットには設定できません。インターバルの最大数は 30 です。 |
restrictedValues[] |
指定された制限付きの値のファセットのみを取得します。テキスト フィールドでのみサポートされます。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「restrictedValues」を「Action > 2022」に設定すると、「category」ファセットには「Action > 2022」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。 |
prefixes[] |
指定された文字列プレフィックスで始まるファセット値のみを取得します。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「prefixes」を「Action」に設定すると、「category」ファセットには「Action > 2022」と「Action > 2021」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。 |
contains[] |
指定された文字列を含むファセット値のみを取得します。たとえば、「category」に「Action > 2022」、「Action > 2021」、「Sci-Fi > 2022」の 3 つの値があるとします。「contains」を「2022」に設定すると、「category」ファセットには「Action > 2022」と「Sci-Fi > 2022」のみが含まれます。テキスト フィールドでのみサポートされます。最大値は 10 です。 |
caseInsensitive |
接頭辞または contains を使用してファセット値を取得するときに、ファセットキーを大文字と小文字を区別しないようにする場合は true。それ以外の場合は false。 |
orderBy |
ドキュメントが返される順序。 指定できる値は次のとおりです。
設定されていない場合、テキスト値は自然順序で並べ替えられ、数値間隔は |
間隔
浮動小数点間隔。
JSON 表現 |
---|
{ // Union field |
Fields | |
---|---|
共用体フィールド このフィールドは最大値以下にする必要があります。それ以外の場合は、 |
|
minimum |
境界値を含む下限。 |
exclusiveMinimum |
境界値を含まない下限。 |
共用体フィールド このフィールドは min 以上である必要があります。それ以外の場合は、 |
|
maximum |
境界値を含む上限。 |
exclusiveMaximum |
境界値を含まない上限。 |
QueryExpansionSpec
クエリ拡張を行う条件を決定する仕様。
JSON 表現 |
---|
{
"condition": enum ( |
フィールド | |
---|---|
condition |
クエリ拡張を行う条件。デフォルトは |
pinUnexpandedResults |
展開されていない結果を固定するかどうか。このフィールドが true に設定されている場合、拡張されていない商品は常に検索結果の先頭に表示され、その後に拡張された結果が表示されます。 |
条件
クエリ拡張を行う条件を説明する列挙型。
列挙型 | |
---|---|
CONDITION_UNSPECIFIED |
クエリ拡張条件が指定されていません。この場合、サーバーの動作はデフォルトで Condition.DISABLED になります。 |
DISABLED |
クエリ拡張が無効になっています。SearchResponse.total_size がゼロの場合でも、完全一致の検索クエリのみが使用されます。 |
AUTO |
Search API によって構築された自動クエリ拡張。 |
SpellCorrectionSpec
クエリのスペル修正の仕様。
JSON 表現 |
---|
{
"mode": enum ( |
フィールド | |
---|---|
mode |
スペル修正によって元の検索クエリが置き換えられるモード。デフォルトは |
モード
スペル修正を行うモードを記述する列挙型。
列挙型 | |
---|---|
MODE_UNSPECIFIED |
スペル修正モードが指定されていません。この場合、サーバーの動作はデフォルトで Mode.AUTO になります。 |
SUGGESTION_ONLY |
Search API はスペル候補を探します。候補が見つかった場合は、SearchResponse.corrected_query に入れられます。スペル候補は検索クエリとして使用されません。 |
AUTO |
Search API によって構築された自動スペル修正。修正されたクエリが見つかった場合、検索は修正されたクエリに基づいて行われます。 |
EmbeddingSpec
カスタマイズされたクエリ エンベディング ベクトルを使用してセマンティック ドキュメント取得を行う仕様。
JSON 表現 |
---|
{
"embeddingVectors": [
{
object ( |
フィールド | |
---|---|
embeddingVectors[] |
取得に使用されるエンベディング ベクトル。1 に制限します。 |
EmbeddingVector
エンベディング ベクトル。
JSON 表現 |
---|
{ "fieldPath": string, "vector": [ number ] } |
フィールド | |
---|---|
fieldPath |
スキーマ内のエンベディング フィールドのパス。 |
vector[] |
クエリ エンベディング ベクトル。 |
RankingExpressionBackend
ランキング式の評価に使用するバックエンド。
列挙型 | |
---|---|
RANKING_EXPRESSION_BACKEND_UNSPECIFIED |
未指定または不明な値のデフォルト オプション。 |
BYOE |
非推奨: 代わりに、 |
CLEARBOX |
非推奨: 代わりに、 |
RANK_BY_EMBEDDING |
カスタム エンベディング モデルによるランキング。ランキング式を評価するデフォルトの方法。 |
RANK_BY_FORMULA |
カスタム数式によるランキング。 |
NaturalLanguageQueryUnderstandingSpec
検索リクエストの自然言語理解機能を有効にするための仕様。
JSON 表現 |
---|
{ "filterExtractionCondition": enum ( |
フィールド | |
---|---|
filterExtractionCondition |
フィルタ抽出を行う条件。サーバーの動作はデフォルトで |
geoSearchQueryDetectionFieldNames[] |
位置情報に基づくフィルタリングに使用されるフィールド名。自然言語検索クエリで位置情報フィルタが検出された場合に使用されます。FilterExtractionCondition が このフィールドが設定されている場合、 |
extractedFilterBehavior |
省略可。抽出されたフィルタが検索に適用される動作を制御します。デフォルトの動作はリクエストによって異なります。単一データストアの構造化検索の場合、デフォルトは |
allowedFieldNames[] |
省略可。自然言語フィルタの抽出に使用できるフィールドの許可リスト。デフォルトでは、この設定が指定されていない場合、インデックス登録可能なすべてのフィールドが自然言語フィルタの抽出対象になります(ただし、必ず使用されるとは限りません)。allowedFieldNames でフィールドが指定されている場合、スキーマでインデックス可能としてマークされ、許可リストで指定されているフィールドのみが自然言語フィルタの抽出の対象となります。注: マルチデータストア検索では、これはまだサポートされておらず、無視されます。 |
FilterExtractionCondition
フィルタの抽出を行う条件を説明する列挙型。
列挙型 | |
---|---|
CONDITION_UNSPECIFIED |
サーバーの動作はデフォルトで DISABLED に設定されます。 |
DISABLED |
NL フィルタの抽出を無効にします。 |
ENABLED |
NL フィルタの抽出を有効にします。 |
ExtractedFilterBehavior
抽出されたフィルタが検索にどのように適用されるかを記述する列挙型。
列挙型 | |
---|---|
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED |
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED は、抽出されたフィルタのデフォルトの動作を使用します。単一データストア検索の場合、デフォルトではハードフィルタとして適用されます。マルチ データストア検索の場合、デフォルトではソフトブーストとして適用されます。 |
HARD_FILTER |
抽出されたすべてのフィルタを結果にハードフィルタとして適用します。抽出されたフィルタを通過しない結果は、結果セットで返されません。 |
SOFT_BOOST |
抽出されたすべてのフィルタをソフトブーストとして適用します。フィルタを通過した結果は、結果セットの上位にブーストされます。 |
SearchAsYouTypeSpec
検索リクエストでの入力中の検索の仕様。
JSON 表現 |
---|
{
"condition": enum ( |
フィールド | |
---|---|
condition |
入力中の検索が行われる条件。デフォルトは |
条件
入力中の検索が実行される条件を記述する列挙型。
列挙型 | |
---|---|
CONDITION_UNSPECIFIED |
サーバーの動作はデフォルトで Condition.DISABLED に設定されます。 |
DISABLED |
入力逐次検索を無効にします。 |
ENABLED |
入力逐次検索を有効にします。 |
AUTO |
入力逐次検索モードと標準検索モードを自動的に切り替えるため、単一 API 実装(デバウンスなど)に最適です。 |
DisplaySpec
一致のハイライト表示など、表示する機能を指定します。
JSON 表現 |
---|
{
"matchHighlightingCondition": enum ( |
フィールド | |
---|---|
matchHighlightingCondition |
一致するハイライト表示を行う条件。 |
MatchHighlightingCondition
一致のハイライト表示を行う条件を記述する列挙型。
列挙型 | |
---|---|
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED |
サーバーの動作は MATCH_HIGHLIGHTING_DISABLED と同じです。 |
MATCH_HIGHLIGHTING_DISABLED |
すべてのドキュメントで一致する部分のハイライト表示を無効にします。 |
MATCH_HIGHLIGHTING_ENABLED |
すべてのドキュメントで一致する部分のハイライト表示を有効にします。 |
SessionSpec
セッションの仕様。
マルチターンの検索機能は現在、限定公開の一般提供段階です。この機能が一般提供(GA)されるまでは、代わりに v1alpha バージョンまたは v1beta バージョンを使用してください。または、Google サポートチームを通じて許可リストへの登録をリクエストしてください。
JSON 表現 |
---|
{ "queryId": string, "searchResultPersistenceCount": integer } |
フィールド | |
---|---|
queryId |
設定されている場合、検索結果はこのクエリ ID で指定された「ターン」に保存されます。 例: セッションが次のようになっているとします。session { name: ".../sessions/xxx" turns { query { text: "What is foo?" queryId: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" queryId: ".../questions/zzz" } } } ユーザーは、次のようなリクエストで /search API を呼び出すことができます。 session: ".../sessions/xxx" sessionSpec { queryId: ".../questions/zzz" } API は、最後のターンに関連付けられた検索結果を保存します。保存された検索結果は、後続の /answer API 呼び出し(セッション ID とクエリ ID を指定)で使用できます。また、同じセッション ID とクエリ ID を使用して /search と /answer を並行して呼び出すこともできます。 |
searchResultPersistenceCount |
保持する上位の検索結果の数。永続化された検索結果は、後続の /answer API 呼び出しに使用できます。 このフィールドは、 ドキュメント モードの場合は最大 10 件、チャンク モードの場合は最大 50 件の結果。 |
RelevanceThreshold
検索結果の関連性のしきい値。関連性のしきい値が高いほど、関連性の高い結果が表示され、返される結果の数が少なくなります。
列挙型 | |
---|---|
RELEVANCE_THRESHOLD_UNSPECIFIED |
デフォルト値。この場合、サーバーの動作はデフォルトで Google が定義したしきい値になります。 |
LOWEST |
関連性のしきい値が最も低い。 |
LOW |
関連性のしきい値が低い。 |
MEDIUM |
関連性のしきい値(中)。 |
HIGH |
関連性のしきい値が高い。 |
RelevanceScoreSpec
ドキュメントの関連性スコアを返すための仕様。
JSON 表現 |
---|
{ "returnRelevanceScore": boolean } |
フィールド | |
---|---|
returnRelevanceScore |
省略可。検索結果の関連性スコアを返すかどうか。スコアが高いほど、ドキュメントがクエリに関連していることを示します。 |
SearchAddonSpec
SearchAddonSpec は、新しい再価格設定モデルに従って検索のアドオンを無効にするために使用されます。SearchAddonSpec が指定されていない場合、デフォルトでは、お客様が適用可能な場所で有効にしたいと考えていると見なされます。
JSON 表現 |
---|
{ "disableSemanticAddOn": boolean, "disableKpiPersonalizationAddOn": boolean, "disableGenerativeAnswerAddOn": boolean } |
フィールド | |
---|---|
disableSemanticAddOn |
省略可。true の場合、セマンティック アドオンは無効になります。セマンティック アドオンには、エンベディングと jetstream が含まれます。 |
disableKpiPersonalizationAddOn |
省略可。true の場合、イベントの再ランキングとパーソナライズを無効にして、KPI を最適化し、結果をパーソナライズします。 |
disableGenerativeAnswerAddOn |
省略可。true の場合、生成回答アドオンは無効になります。生成回答アドオンには、自然言語からフィルタへの変換とシンプルな回答が含まれています。 |
QuerySetSpec
クエリセットの仕様を記述します。
JSON 表現 |
---|
{ "sampleQuerySet": string } |
フィールド | |
---|---|
sampleQuerySet |
省略可。評価に使用される |
QualityMetrics
評価によって生成された指標について説明します。
JSON 表現 |
---|
{ "docRecall": { object ( |
フィールド | |
---|---|
docRecall |
さまざまな Top-K カットオフ レベルにおけるドキュメントあたりの再現率。 再現率は、すべての関連ドキュメントのうち、取得された関連ドキュメントの割合です。 例(上位 5 件): * 1 つの |
docPrecision |
さまざまな Top-K カットオフ レベルにおけるドキュメントあたりの適合率。 適合率は、取得されたドキュメントのうち関連性のあるドキュメントの割合です。 例(上位 5 件): * 単一の |
docNdcg |
さまざまな Top-K カットオフ レベルにおける、ドキュメントあたりの正規化された減損累積利得(NDCG)。 NDCG はランキングの品質を測定し、上位の結果に高い関連性を与えます。 例(上位 3 件): 3 つの取得ドキュメント(D1、D2、D3)と、関連性のバイナリ判定(関連性ありの場合は 1、関連性なしの場合は 0)を含む 取得: [D3 (0)、D1 (1)、D2 (1)] 理想: [D1 (1)、D2 (1)、D3 (0)] 各 |
pageRecall |
さまざまな Top-K カットオフ レベルでのページあたりの再現率。 再現率は、すべての関連ページのうち、取得された関連ページの割合です。 例(上位 5 件): * 1 つの |
pageNdcg |
さまざまな Top-K のカットオフ レベルにおける、ページあたりの正規化された減損累積利得(NDCG)。 NDCG はランキングの品質を測定し、上位の結果に高い関連性を与えます。 例(上位 3 件): 3 つの取得済みページ(P1、P2、P3)とバイナリ関連性判定(関連性ありの場合は 1、関連性なしの場合は 0)を含む 取得済み: [P3(0)、P1(1)、P2(1)] 理想: [P1(1)、P2(1)、P3(0)]
|
TopkMetrics
特定のトップ k レベルで指標値を保存します。
JSON 表現 |
---|
{ "top1": number, "top3": number, "top5": number, "top10": number } |
フィールド | |
---|---|
top1 |
上位 1 つの値。 |
top3 |
上位 3 つの値。 |
top5 |
上位 5 つの値。 |
top10 |
上位 10 個の値。 |
状態
評価の状態を表します。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
評価が指定されていません。 |
PENDING |
サービスは評価を実行する準備をしています。 |
RUNNING |
評価が進行中です。 |
SUCCEEDED |
評価は正常に完了しました。 |
FAILED |
評価に失敗しました。 |
メソッド |
|
---|---|
|
Evaluation を作成します。 |
|
Evaluation を取得します。 |
|
Evaluation のリストを取得します。 |
|
指定された Evaluation の結果のリストを取得します。 |