SearchIndex 類別

表示搜尋索引定義，描述索引的欄位和搜尋行為。

必須填入所有必要的參數，才能傳送至 Azure。

繼承

azure.search.documents.indexes._generated._serialization.Model

SearchIndex

建構函式

SearchIndex(**kwargs)

變數

名稱	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] 索引的 Tokenizer。
token_filters	list[TokenFilter] 索引的權杖篩選。
char_filters	list[CharFilter] 索引的字元篩選。
encryption_key	SearchResourceEncryptionKey 您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完整保證，即使 Microsoft 也無法在Azure 認知搜尋中解密您的資料時，此金鑰可用來為您的資料提供額外的待用加密層級。 加密資料之後，它一律會保持加密狀態。 Azure 認知搜尋會忽略將此屬性設定為 null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的資料不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用于在 2019 年 1 月 1 日或之後建立的付費服務。
similarity	SimilarityAlgorithm 評分和排名符合搜尋查詢的檔時，要使用的相似度演算法類型。 相似度演算法只能在建立索引時定義，而且無法在現有索引上修改。 如果為 null，則會使用 ClassicSimilarity 演算法。
semantic_search	SemanticSearch 定義影響語意功能的搜尋索引參數。
vector_search	VectorSearch 定義會影響向量空間中評分的搜尋索引參數。
e_tag	str 索引的 ETag。

方法

as_dict	傳回可使用 json.dump 序列化的聽寫。 進階用法可以選擇性地使用回呼作為參數： 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果您想要 XML 序列化，您可以傳遞 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 序列化，您可以傳遞 kwargs is_xml=True。

as_dict

傳回可使用 json.dump 序列化的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 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]

參數

名稱	Description
key_transformer	<xref:function> 按鍵轉換程式函式。
keep_readonly	預設值: True

傳回

類型	Description
dict	聽寫 JSON 相容物件

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

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

參數

名稱	Description
data 必要	str 使用 RestAPI 結構的 str。 根據預設，JSON。
content_type	str 根據預設，如果 XML，請設定 application/xml。 預設值: None

傳回

類型	Description
	此模型的實例

例外狀況

類型	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

參數

名稱	Description
data 必要	dict 使用 RestAPI 結構的聽寫
content_type	str 根據預設，如果 XML，請設定 application/xml。 預設值: None
key_extractors	預設值: None

傳回

類型	Description
	此模型的實例

例外狀況

類型	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 序列化，您可以傳遞 kwargs is_xml=True。

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

參數

名稱	Description
keep_readonly	bool 如果您想要序列化唯讀屬性 預設值: False

傳回

類型	Description
dict	聽寫 JSON 相容物件