VectorQuery クラス

  • リファレンス

ベクター検索クエリとハイブリッド検索クエリのクエリ パラメーター。

このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。 既知のサブクラス: VectorizedQuery

Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

継承
azure.search.documents._generated._serialization.Model
VectorQuery

コンストラクター

VectorQuery(*, k_nearest_neighbors: int | None = None, fields: str | None = None, exhaustive: bool | None = None, **kwargs: Any)

Keyword-Only パラメータ

名前 説明
k_nearest_neighbors
int

トップ ヒットとして返される最も近い近隣の数。
fields
str

検索されるベクターに含める Collection(Edm.Single) 型のベクター フィールド。
exhaustive
bool

true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。 グラウンド トゥルース値の決定など、完全一致が重要なシナリオに役立ちます。

変数

名前 説明
kind
str または <xref:search_index_client.models.VectorQueryKind>

実行されるベクター クエリの種類。 必須。 "vector"
k_nearest_neighbors
int

トップ ヒットとして返される最も近い近隣の数。
fields
str

検索されるベクターに含める Collection(Edm.Single) 型のベクター フィールド。
exhaustive
bool

true の場合、ベクトル インデックス内のすべてのベクトルに対して、完全な k に最も近い近隣検索がトリガーされます。 グラウンド トゥルース値の決定など、完全一致が重要なシナリオに役立ちます。

メソッド

as_dict

json.dump を使用してシリアル化できる dict を返します。

高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。

キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 3 つの例を参照してください。

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

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' が含まれています。 値は、このオブジェクトの現在の値です。

返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。

このファイルの 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

dict JSON 互換オブジェクト

deserialize

RestAPI 構文を使用して str を解析し、モデルを返します。

deserialize(data: Any, content_type: str | None = None) -> ModelType

パラメーター

名前 説明
data
必須
str

RestAPI 構造体を使用する str。 既定では JSON。
content_type
str

JSON は既定で、application/xml if XML を設定します。

既定値: None

戻り値

型 説明

このモデルのインスタンス

例外

型 説明
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_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
必須
dict

RestAPI 構造体を使用したディクテーション
content_type
str

JSON は既定で、application/xml if XML を設定します。

既定値: None
key_extractors
既定値: None

戻り値

型 説明

このモデルのインスタンス

例外

型 説明
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

このモデルからサーバーに送信される 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
bool

readonly 属性をシリアル化する場合

既定値: False

戻り値

型 説明
dict

dict JSON 互換オブジェクト