SuggestOptions クラス
パラメーター グループ。
- 継承
-
azure.search.documents._generated._serialization.ModelSuggestOptions
コンストラクター
SuggestOptions(*, filter: str | None = None, use_fuzzy_matching: bool | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, order_by: List[str] | None = None, search_fields: List[str] | None = None, select: List[str] | None = None, top: int | None = None, **kwargs: Any)Keyword-Only パラメータ
| 名前 | 説明 |
|---|---|
|
filter
|
候補と見なされるドキュメントをフィルター処理する OData 式。 |
|
use_fuzzy_matching
|
候補クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語を検索します。 一部のシナリオではエクスペリエンスが向上しますが、あいまい候補クエリの速度が低下し、リソースが多く消費されるため、パフォーマンス コストがかかります。 |
|
highlight_post_tag
|
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。 |
|
highlight_pre_tag
|
ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。 |
|
minimum_coverage
|
クエリを成功として報告するために候補クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。 |
|
order_by
|
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示し、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大で 32 個の$orderby句を指定できます。 |
|
search_fields
|
指定した検索テキストを検索するフィールド名の一覧。 ターゲット フィールドは、指定した suggester に含まれている必要があります。 |
|
select
|
取得するフィールドの一覧。 指定しない場合は、キー フィールドのみが結果に含まれます。 |
|
top
|
取得する候補の数。 値は 1 ~ 100 の数値である必要があります。既定値は 5 です。 |
変数
| 名前 | 説明 |
|---|---|
|
filter
|
候補と見なされるドキュメントをフィルター処理する OData 式。 |
|
use_fuzzy_matching
|
候補クエリにあいまい一致を使用するかどうかを示す値。 既定値は false です。 true に設定すると、検索テキストに置換文字または欠落文字がある場合でも、クエリは用語を検索します。 一部のシナリオではエクスペリエンスが向上しますが、あいまい候補クエリの速度が低下し、リソースが多く消費されるため、パフォーマンス コストがかかります。 |
|
highlight_post_tag
|
ヒットハイライトに追加される文字列タグ。 highlightPreTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。 |
|
highlight_pre_tag
|
ヒットハイライトの前に付加される文字列タグ。 highlightPostTag を使用して設定する必要があります。 省略すると、候補の強調表示が無効になります。 |
|
minimum_coverage
|
クエリを成功として報告するために候補クエリでカバーする必要があるインデックスの割合を示す 0 ~ 100 の範囲の数値。 このパラメーターは、レプリカが 1 つだけのサービスでも検索の可用性を確保するのに役立ちます。 既定値は 80 です。 |
|
order_by
|
結果を並べ替える OData $orderby式の一覧。 各式には、フィールド名または geo.distance() 関数または search.score() 関数の呼び出しを指定できます。 各式の後に asc を付けて昇順を示し、降順を示す desc を指定できます。 既定値は昇順です。 結び付きは、ドキュメントの一致スコアによって切り離されます。 $orderbyが指定されていない場合、既定の並べ替え順序はドキュメント一致スコアの降順になります。 最大で 32 個の$orderby句を指定できます。 |
|
search_fields
|
指定した検索テキストを検索するフィールド名の一覧。 ターゲット フィールドは、指定した suggester に含まれている必要があります。 |
|
select
|
取得するフィールドの一覧。 指定しない場合は、キー フィールドのみが結果に含まれます。 |
|
top
|
取得する候補の数。 値は 1 ～ 100 の数値である必要があります。 既定値は 5 です。 |
メソッド
| as_dict |
json.dump を使用してシリアル化できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。 このファイルの 3 つの例を参照してください。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
| deserialize |
RestAPI 構文を使用して str を解析し、モデルを返します。 |
| enable_additional_properties_sending | |
| from_dict |
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。 既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください |
| is_xml_model | |
| serialize |
このモデルからサーバーに送信される JSON を返します。 これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。 XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
as_dict
json.dump を使用してシリアル化できる dict を返します。
高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。
キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果 dict と見なされます。
このファイルの 3 つの例を参照してください。
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]パラメーター
| 名前 | 説明 |
|---|---|
|
key_transformer
|
<xref:function>
キー トランスフォーマー関数。 |
|
keep_readonly
|
既定値: True
|
戻り値
| 型 | 説明 |
|---|---|
|
dict JSON 互換オブジェクト |
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data: Any, content_type: str | None = None) -> ModelTypeパラメーター
| 名前 | 説明 |
|---|---|
|
data
必須
|
RestAPI 構造体を使用する str。 既定では JSON。 |
|
content_type
|
既定では JSON、XML の場合は application/xml を設定します。 既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
このモデルのインスタンス |
例外
| 型 | 説明 |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_dict
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。
既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください
from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelTypeパラメーター
| 名前 | 説明 |
|---|---|
|
data
必須
|
RestAPI 構造体を使用したディクテーション |
|
content_type
|
既定では JSON、XML の場合は application/xml を設定します。 既定値: None
|
|
key_extractors
|
既定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
このモデルのインスタンス |
例外
| 型 | 説明 |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
このモデルからサーバーに送信される JSON を返します。
これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]パラメーター
| 名前 | 説明 |
|---|---|
|
keep_readonly
|
読み取り専用属性をシリアル化する場合 既定値: False
|
戻り値
| 型 | 説明 |
|---|---|
|
dict JSON 互換オブジェクト |
Azure SDK for Python