REST Resource: projects.locations.corpora.searchConfigs

リソース: SearchConfig

SearchConfig には、検索動作と検索結果に影響するさまざまなプロパティが保存されます。

JSON 表現 
{
  "name": string,
  "facetProperty": {
    object (FacetProperty)
  },
  "searchCriteriaProperty": {
    object (SearchCriteriaProperty)
  }
}
フィールド
name

string

検索構成のリソース名。CustomSearchCriteria の場合、searchConfig は検索演算子名になります。ファセットの場合、searchConfig はファセット ディメンション名になります。フォーム: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}
facetProperty

object (FacetProperty)

FacetDimension と関連する仕様を確立します。
searchCriteriaProperty

object (SearchCriteriaProperty)

カスタム SearchCriteria と 1 つ以上の UGA キーとのマッピングを作成します。

FacetProperty

ファセットの一元的な構成。

JSON 表現 
{
  "mappedFields": [
    string
  ],
  "displayName": string,
  "resultSize": string,
  "bucketType": enum (FacetBucketType),

  // Union field range_facet_config can be only one of the following:
  "fixedRangeBucketSpec": {
    object (FixedRangeBucketSpec)
  },
  "customRangeBucketSpec": {
    object (CustomRangeBucketSpec)
  },
  "datetimeBucketSpec": {
    object (DateTimeBucketSpec)
  }
  // End of list of possible types for union field range_facet_config.
}
フィールド
mappedFields[]

string

ファセットの名前。これは、ユーザーが検索結果の絞り込みに使用するディメンションです。mappedFields は UserSpecifiedDataSchema キーと一致します。

たとえば、ユーザーは同じキー（player:adam、player:bob、player:charles など）を使用して複数の UGA を追加できます。複数の mappedFields が指定されている場合は、その値が最終的なファセット値として統合されます。例: home_team: a, home_team:b, away_team:a, away_team:c、facet_field = [home_team, away_team] の場合、facet_value は [a, b, c] になります。

1:1 ファセット ディメンション（mappedFields.size() == 1）で、mapped_field が親の SearchConfig.name と等しい場合を除き、親には同じフィールドにマッピングされる SearchCriteriaProperty も含まれている必要があります。mappedFields は空にできません。
displayName

string

ファセットの表示名。UI でファセットのレンダリングに使用されます。
resultSize

string (int64 format)

1 つのファセットで返される一意のバケットの最大数。バケット数は、「player」などの高基数ファセットでは大きくなります。ユーザーに返されるのは、最も関連性の高い上位 n 件のみです。0 以下の場合、サーバーが適切な resultSize を決定します。
bucketType

enum (FacetBucketType)

ファセットのバケットタイプ（値、範囲など）。

共用体フィールド range_facet_config。

range_facet_config は次のいずれかになります。
fixedRangeBucketSpec

object (FixedRangeBucketSpec)

固定範囲のファセット バケットの構成を修正しました。
customRangeBucketSpec

object (CustomRangeBucketSpec)

カスタム範囲のフェイスタ バケットの構成。
datetimeBucketSpec

object (DateTimeBucketSpec)

日時範囲のファセット バケットの構成。

FixedRangeBucketSpec

バケットタイプが FIXED_RANGE の場合は、値をバケット化する方法を指定します。同じ粒度の複数のバケットを作成する場合は、FixedRangeBucketSpec を使用します。整数のバケット値を例に取ると、bucketStart = 0、bucketGranularity = 10、bucketCount = 5 の場合、このファセットは次のバケットにより集計されます。[-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf)。特に、bucketCount <= 1 は無効な仕様です。

JSON 表現 
{
  "bucketStart": {
    object (FacetValue)
  },
  "bucketGranularity": {
    object (FacetValue)
  },
  "bucketCount": integer
}
フィールド
bucketStart

object (FacetValue)

バケットの下限。注: 現在、このフィールドでサポートされているのは整数型のみです。
bucketGranularity

object (FacetValue)

バケットの粒度。注: 現在、このフィールドでサポートされているのは整数型のみです。
bucketCount

integer

バケットの合計数。

FacetValue

ジェネリック型の単一値の定義。

JSON 表現 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "datetimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
フィールド

共用体フィールド value。

value は次のいずれかになります。
stringValue

string

文字列型の値。
integerValue

string (int64 format)

整数型の値。
datetimeValue

object (DateTime)

日時型の値。

CustomRangeBucketSpec

バケットタイプが CUSTOM_RANGE の場合は、値をバケット化する方法を指定します。整数バケット値を例に挙げると、エンドポイントが 0、10、100、1000 の場合、次のファセットが生成されます。[-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf)。特に、エンドポイントは昇順で指定する必要があります。そうでない場合、SearchConfig API はファセット構成を拒否します。- エンドポイントが 1 つ未満の場合は、仕様が無効です。

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

object (FacetValue)

現在、このフィールドでは整数型のみがサポートされています。

DateTimeBucketSpec

バケットタイプが DATE の場合は、日付値をバケット化する方法を指定します。

JSON 表現 
{
  "granularity": enum (Granularity)
}
フィールド
granularity

enum (Granularity)

日付タイプのファセットの粒度。

粒度

日時バケットの粒度の列挙型。

列挙型
GRANULARITY_UNSPECIFIED 粒度が指定されていません。
YEAR 粒度は年単位です。
MONTH 粒度は月単位です。
DAY 粒度は日単位です。

FacetBucketType

ファセット バケットのさまざまなタイプ。

列挙型
FACET_BUCKET_TYPE_UNSPECIFIED 未指定のタイプ。
FACET_BUCKET_TYPE_VALUE 値の型。
FACET_BUCKET_TYPE_DATETIME 日時型。
FACET_BUCKET_TYPE_FIXED_RANGE 固定範囲のタイプ。
FACET_BUCKET_TYPE_CUSTOM_RANGE カスタム範囲の種類。

SearchCriteriaProperty

カスタム検索条件の一元管理。

JSON 表現 
{
  "mappedFields": [
    string
  ]
}
フィールド
mappedFields[]

string

各 mapped_field は UGA キーに対応しています。このプロパティの仕組みを理解するには、次の例をご覧ください。SearchConfig テーブルに、次のエントリを追加します。searchConfig { name: "person" searchCriteriaProperty { mappedFields: "player" mappedFields: "coach" } }

ユーザーが次のようなクエリを実行すると、criteria { field: "person" textArray { txtValues: "Tom Brady" txtValues: "Bill Belichick" } }

MWH 検索では、（player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick）の検索ドキュメントが返されます。

メソッド

create

 コーパス内に検索構成を作成します。

delete

 コーパス内の検索構成を削除します。

get

 コーパス内の検索構成を取得します。

list

 コーパス内のすべての検索構成を一覧表示します。

patch

 コーパス内の検索構成を更新します。