VectorQuery Třída

Parametry dotazu pro vektorové a hybridní vyhledávací dotazy.

Pravděpodobně chcete použít podtřídy, a ne přímo tuto třídu. Známé podt třídy jsou: VectorizedQuery

Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.

Dědičnost

azure.search.documents._generated._serialization.Model

VectorQuery

Konstruktor

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

Výhradně parametry klíčových slov

Name	Description
k_nearest_neighbors	int Počet nejbližších sousedů, které se mají vrátit jako nejvyšší počet přístupů
fields	str Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do hledaného vektoru.
exhaustive	bool Pokud je true, aktivuje vyčerpávající hledání k-nejbližšího souseda napříč všemi vektory v indexu vektorů. Užitečné pro scénáře, ve kterých jsou přesné shody kritické, jako je určování hodnot základní pravdy.

Proměnné

Name	Description
kind	str nebo <xref:search_index_client.models.VectorQueryKind> Druh vektorového dotazu, který se provádí. Povinná hodnota. "vector"
k_nearest_neighbors	int Počet nejbližších sousedů, které se mají vrátit jako nejvyšší počet přístupů
fields	str Vektorová pole typu Collection(Edm.Single), která mají být zahrnuta do hledaného vektoru.
exhaustive	bool Pokud je true, aktivuje vyčerpávající hledání k-nejbližšího souseda napříč všemi vektory v indexu vektorů. Užitečné pro scénáře, ve kterých jsou přesné shody kritické, jako je určování hodnot základní pravdy.

Metody

as_dict	Vrátí dikt, který lze serializovat pomocí json.dump. Rozšířené využití může volitelně použít zpětné volání jako parametr: Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu. Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku. Podívejte se na tři příklady v tomto souboru: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.
deserialize	Parsujte str pomocí syntaxe RestAPI a vraťte model.
enable_additional_properties_sending
from_dict	Analýza diktu pomocí daného extraktoru klíčů vrátí model. Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).
is_xml_model
serialize	Vrátí kód JSON, který se odešle na server z tohoto modelu. Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False). Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict

Vrátí dikt, který lze serializovat pomocí json.dump.

Rozšířené využití může volitelně použít zpětné volání jako parametr:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. V současné době obsahuje "type" s typem msrest a "key" s klíčem kódovaným restAPI. Hodnota je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat 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]

Parametry

Name	Description
key_transformer	<xref:function> Funkce klíčového transformátoru.
keep_readonly	výchozí hodnota: True

Návraty

Typ	Description
dict	Objekt kompatibilní s diktem JSON

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

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

Parametry

Name	Description
data Vyžadováno	str Str používající strukturu RestAPI. Ve výchozím nastavení JSON.
content_type	str Ve výchozím nastavení JSON nastavte application/xml, pokud XML. výchozí hodnota: None

Návraty

Typ	Description
	Instance tohoto modelu

Výjimky

Typ	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analýza diktu pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a 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

Parametry

Name	Description
data Vyžadováno	dict Diktování pomocí struktury RestAPI
content_type	str Ve výchozím nastavení JSON nastavte application/xml, pokud XML. výchozí hodnota: None
key_extractors	výchozí hodnota: None

Návraty

Typ	Description
	Instance tohoto modelu

Výjimky

Typ	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Vrátí kód JSON, který se odešle na server z tohoto modelu.

Toto je alias pro as_dict(full_restapi_key_transformer; keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parametry

Name	Description
keep_readonly	bool Pokud chcete serializovat atributy readonly výchozí hodnota: False

Návraty

Typ	Description
dict	Objekt kompatibilní s diktem JSON