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)

키워드 전용 매개 변수

Name Description
k_nearest_neighbors
int

상위 적중으로 반환할 가장 가까운 이웃의 수입니다.
fields
str

검색된 벡터에 포함할 Collection(Edm.Single) 형식의 벡터 필드입니다.
exhaustive
bool

true이면 벡터 인덱스 내의 모든 벡터에서 K-가장 가까운 전체 인접 검색을 트리거합니다. 정확한 일치 항목이 중요한 시나리오(예: 접지 진리 값 결정)에 유용합니다.

변수

Name Description
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를 사용하여 serialize할 수 있는 받아쓰기를 반환합니다.

고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다.

키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식이 있는 'type'과 RestAPI 인코딩된 키가 있는 'key'가 포함되어 있습니다. 값은 이 개체의 현재 값입니다.

반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다.

이 파일의 세 가지 예제를 참조하세요.

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML serialization을 원하는 경우 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 serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.

as_dict

json.dump를 사용하여 serialize할 수 있는 받아쓰기를 반환합니다.

고급 사용은 필요에 따라 콜백을 매개 변수로 사용할 수 있습니다.

키는 Python에서 사용되는 특성 이름입니다. Attr_desc 메타데이터의 받아쓰기입니다. 현재 msrest 형식이 있는 'type'과 RestAPI 인코딩된 키가 있는 'key'가 포함되어 있습니다. 값은 이 개체의 현재 값입니다.

반환된 문자열은 키를 serialize하는 데 사용됩니다. 반환 형식이 목록인 경우 계층적 결과 받아쓰기로 간주됩니다.

이 파일의 세 가지 예제를 참조하세요.

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML serialization을 원하는 경우 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]

매개 변수

Name Description
key_transformer
<xref:function>

키 변환기 함수입니다.
keep_readonly
기본값: True

반환

형식 Description
dict

dict JSON 호환 개체

deserialize

RestAPI 구문을 사용하여 str를 구문 분석하고 모델을 반환합니다.

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

매개 변수

Name Description
data
필수
str

RestAPI 구조를 사용하는 str입니다. 기본적으로 JSON입니다.
content_type
str

기본적으로 JSON은 XML인 경우 application/xml을 설정합니다.

기본값: None

반환

형식 Description

이 모델의 instance

예외

형식 Description
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

매개 변수

Name Description
data
필수
dict

RestAPI 구조를 사용하는 받아쓰기
content_type
str

기본적으로 JSON은 XML인 경우 application/xml을 설정합니다.

기본값: None
key_extractors
기본값: None

반환

형식 Description

이 모델의 instance

예외

형식 Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

이 모델에서 서버로 보낼 JSON을 반환합니다.

이는 as_dict(full_restapi_key_transformer, keep_readonly=False)에 대한 별칭입니다.

XML serialization을 원하는 경우 kwargs is_xml=True를 전달할 수 있습니다.

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

매개 변수

Name Description
keep_readonly
bool

읽기 전용 특성을 직렬화하려는 경우

기본값: False

반환

형식 Description
dict

dict JSON 호환 개체