VectorQuery Klass

Frågeparametrarna för vektor- och hybridsökfrågor.

Du vill förmodligen använda underklasserna och inte den här klassen direkt. Kända underklasser är: VectorizedQuery

Alla obligatoriska parametrar måste fyllas i för att kunna skickas till Azure.

Arv

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)

Keyword-Only parametrar

Name	Description
k_nearest_neighbors	int Antal närmaste grannar som ska returneras som toppträffar.
fields	str Vektorfält av typen Samling (Edm.Single) som ska inkluderas i den sökbara vektorn.
exhaustive	bool När det är sant utlöser en fullständig k-närmaste granne-sökning över alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.

Variabler

Name	Description
kind	str eller <xref:search_index_client.models.VectorQueryKind> Den typ av vektorfråga som utförs. Krävs. "vektor"
k_nearest_neighbors	int Antal närmaste grannar som ska returneras som toppträffar.
fields	str Vektorfält av typen Samling (Edm.Single) som ska inkluderas i den sökbara vektorn.
exhaustive	bool När det är sant utlöser en fullständig k-närmaste granne-sökning över alla vektorer i vektorindexet. Användbart för scenarier där exakta matchningar är kritiska, till exempel att fastställa grundsanningsvärden.

Metoder

as_dict	Returnera en diktamen som kan serialiseras med json.dump. Avancerad användning kan också använda ett återanrop som parameter: Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet. Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt. Se de tre exemplen i den här filen: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.
deserialize	Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.
enable_additional_properties_sending
from_dict	Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell. Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Returnera den JSON som skulle skickas till servern från den här modellen. Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False). Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

as_dict

Returnera en diktamen som kan serialiseras med json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en diktering av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med den RestAPI-kodade nyckeln. Värde är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka 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]

Parametrar

Name	Description
key_transformer	<xref:function> En nyckeltransformatorfunktion.
keep_readonly	standardvärde: True

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

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

Parametrar

Name	Description
data Obligatorisk	str En str som använder RestAPI-struktur. JSON som standard.
content_type	str JSON anger som standard application/xml om XML. standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parsa en diktamen med hjälp av den angivna nyckelextraktorn returnerar en modell.

Som standard bör du överväga nyckelextraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och 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

Parametrar

Name	Description
data Obligatorisk	dict En diktamen som använder RestAPI-struktur
content_type	str JSON anger som standard application/xml om XML. standardvärde: None
key_extractors	standardvärde: None

Returer

Typ	Description
	En instans av den här modellen

Undantag

Typ	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Returnera den JSON som skulle skickas till servern från den här modellen.

Det här är ett alias för as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

Name	Description
keep_readonly	bool Om du vill serialisera skrivskyddade attribut standardvärde: False

Returer

Typ	Description
dict	Ett dict JSON-kompatibelt objekt