Condividi tramite

VectorQuery Classe

  • Riferimento

Parametri di query per query di ricerca ibrida e vettore.

Probabilmente si vuole usare le sottoclassi e non direttamente questa classe. Le sottoclassi note sono: VectorizedQuery

Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.

Ereditarietà
azure.search.documents._generated._serialization.Model
VectorQuery

Costruttore

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

Parametri solo parole chiave

Nome Descrizione
k_nearest_neighbors
int

Numero di vicini più vicini da restituire come risultati principali.
fields
str

Campi vettoriali di tipo Collection(Edm.Single) da includere nel vettore cercato.
exhaustive
bool

Se true, attiva una ricerca più vicina e completa tra tutti i vettori all'interno dell'indice vettore. Utile per gli scenari in cui le corrispondenze esatte sono critiche, ad esempio determinare i valori di verità di terra.

Variabili

Nome Descrizione
kind
str oppure <xref:search_index_client.models.VectorQueryKind>

Tipo di query vettoriale eseguita. Obbligatorio. "vettore"
k_nearest_neighbors
int

Numero di vicini più vicini da restituire come risultati principali.
fields
str

Campi vettoriali di tipo Collection(Edm.Single) da includere nel vettore cercato.
exhaustive
bool

Se true, attiva una ricerca più vicina e completa tra tutti i vettori all'interno dell'indice vettore. Utile per gli scenari in cui le corrispondenze esatte sono critiche, ad esempio determinare i valori di verità di terra.

Metodi

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i 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]

Parametri

Nome Descrizione
key_transformer
<xref:function>

Funzione di trasformatore chiave.
keep_readonly
valore predefinito: True

Restituisce

Tipo Descrizione
dict

Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome Descrizione
data
Necessario
str

Str usando la struttura RestAPI. JSON per impostazione predefinita.
content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parametri

Nome Descrizione
data
Necessario
dict

Dict using RestAPI structure
content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None
key_extractors
valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome Descrizione
keep_readonly
bool

Se si vuole serializzare gli attributi readonly

valore predefinito: False

Restituisce

Tipo Descrizione
dict

Oggetto compatibile con JSON dict