VectorQuery Classe

Os parâmetros de consulta para consultas de pesquisa híbrida e vetor.

Você provavelmente deseja usar as subclasses e não essa classe diretamente. Subclasses conhecidas são: VectorizedQuery

Todos os parâmetros necessários devem ser preenchidos para enviar ao Azure.

Herança

azure.search.documents._generated._serialization.Model

VectorQuery

Construtor

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

Parâmetros de apenas palavra-chave

Nome	Description
k_nearest_neighbors	int Número de vizinhos mais próximos a serem retornados como principais ocorrências.
fields	str Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.
exhaustive	bool Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

Variáveis

Nome	Description
kind	str ou <xref:search_index_client.models.VectorQueryKind> O tipo de consulta vetor que está sendo executada. Obrigatórios. "vector"
k_nearest_neighbors	int Número de vizinhos mais próximos a serem retornados como principais ocorrências.
fields	str Campos vetoriais do tipo Collection(Edm.Single) a serem incluídos no vetor pesquisado.
exhaustive	bool Quando true, dispara uma pesquisa exaustiva de k-neighbor mais próxima em todos os vetores dentro do índice de vetor. Útil para cenários em que correspondências exatas são críticas, como determinar valores de verdade básicos.

Métodos

as_dict	Retornar um ditado que pode ser serializado usando json.dump. O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro: Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto. A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico. Confira os três exemplos neste arquivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize	Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado usando determinado extrator de chave retorna um modelo. Por padrão, considere extratores de chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retorne o JSON que seria enviado para o servidor desse modelo. Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

as_dict

Retornar um ditado que pode ser serializado usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os 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]

Parâmetros

Nome	Description
key_transformer	<xref:function> Uma função de transformador de chave.
keep_readonly	valor padrão: True

Retornos

Tipo	Description
dict	Um objeto compatível com JSON de ditado

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

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

Parâmetros

Nome	Description
data Obrigatório	str Um str usando a estrutura RestAPI. JSON por padrão.
content_type	str JSON por padrão, defina application/xml se XML. valor padrão: None

Retornos

Tipo	Description
	Uma instância desse modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de chave (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

Parâmetros

Nome	Description
data Obrigatório	dict Um ditado usando a estrutura RestAPI
content_type	str JSON por padrão, defina application/xml se XML. valor padrão: None
key_extractors	valor padrão: None

Retornos

Tipo	Description
	Uma instância desse modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retorne o JSON que seria enviado para o servidor desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

Nome	Description
keep_readonly	bool Se você quiser serializar os atributos somente leitura valor padrão: False

Retornos

Tipo	Description
dict	Um objeto compatível com JSON de ditado