다음을 통해 공유

SearchIndex 클래스

  • 참조

인덱스의 필드 및 검색 동작을 설명하는 검색 인덱스 정의를 나타냅니다.

Azure로 보내려면 모든 필수 매개 변수를 채워야 합니다.

상속
azure.search.documents.indexes._generated._serialization.Model
SearchIndex

생성자

SearchIndex(**kwargs)

변수

Name Description
name
str

필수 사항입니다. 인덱스의 이름입니다.
fields
list[SearchField]

필수 사항입니다. 인덱스의 필드입니다.
scoring_profiles
list[ScoringProfile]

인덱스에 대한 점수 매기기 프로필입니다.
default_scoring_profile
str

쿼리에 지정되지 않은 경우 사용할 점수 매기기 프로필의 이름입니다. 이 속성이 설정되지 않고 쿼리에 점수 매기기 프로필이 지정되지 않은 경우 기본 점수 매기기(tf-idf)가 사용됩니다.
cors_options
CorsOptions

인덱스에 대한 CORS(원본 간 리소스 공유)를 제어하는 옵션입니다.
suggesters
list[SearchSuggester]

인덱스 제안기입니다.
analyzers
list[LexicalAnalyzer]

인덱스에 대한 분석기입니다.
tokenizers
list[LexicalTokenizer]

인덱스에 대한 토큰라이저입니다.
token_filters
list[TokenFilter]

인덱스에 대한 토큰 필터입니다.
char_filters
list[CharFilter]

인덱스에 대한 문자 필터입니다.
encryption_key
SearchResourceEncryptionKey

Azure Key Vault 만드는 암호화 키에 대한 설명입니다. 이 키는 Microsoft를 비롯한 누구도 Azure Cognitive Search 데이터의 암호를 해독할 수 없다는 완전한 보증을 원할 때 데이터에 대한 추가 수준의 미사용 암호화를 제공하는 데 사용됩니다. 데이터를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. Azure Cognitive Search 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전하려는 경우 필요에 따라 이 속성을 변경할 수 있습니다. 데이터는 영향을 받지 않습니다. 고객 관리형 키를 사용하는 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 또는 그 이후에 생성된 유료 서비스에만 사용할 수 있습니다.
similarity
SimilarityAlgorithm

검색 쿼리와 일치하는 문서의 점수를 매기고 순위를 지정하는 데 사용할 유사성 알고리즘의 유형입니다. 유사성 알고리즘은 인덱스를 만들 때만 정의할 수 있으며 기존 인덱스에서 수정할 수 없습니다. null이면 ClassicSimilarity 알고리즘이 사용됩니다.
semantic_search
SemanticSearch

의미 체계 기능에 영향을 주는 검색 인덱스에 대한 매개 변수를 정의합니다.
vector_search
VectorSearch

벡터 공간의 점수 매기기에서 영향을 주는 검색 인덱스에 대한 매개 변수를 정의합니다.
e_tag
str

인덱스의 ETag입니다.

메서드

as_dict

json.dump를 사용하여 serialize할 수 있는 dict를 반환합니다.

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

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

반환된 문자열은 키를 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할 수 있는 dict를 반환합니다.

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

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

반환된 문자열은 키를 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 호환 개체