AnalyzeTextOptions 類別

指定一些用來將該文字分成標記的文字和分析元件。

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

繼承

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

AnalyzeTextOptions

建構函式

AnalyzeTextOptions(**kwargs)

變數

名稱	Description
text	str 必要。 要分成標記的文字。
analyzer_name	str 或 LexicalAnalyzerName 用來中斷指定文字的分析器名稱。 如果未指定此參數，您必須改為指定 Tokenizer。 Tokenizer 和 analyzer 參數互斥。 可能的值包括：「ar.microsoft」、「ar.lucene」、「hy.lucene」、 「bn.microsoft」， 「eu.lucene」， 「bg.microsoft」， 「bg.lucene」， 「ca.microsoft」， 「ca.lucene」， 「zh- Hans.microsoft」， 「zh-Hans.lucene」， 「zh-Hant.microsoft」， 「zh-Hant.lucene」， 「hr.microsoft」， 「cs.microsoft」， 「cs.lucene」， 「da.microsoft」， 「da.lucene」， 「nl.microsoft」， 「nl.lucene」， 「en.microsoft」， 「en.lucene」， 「et.microsoft」， 「fi.lucene」， 「fi.lucene」， 「fr.microsoft」， 「fr.lucene」， 「gl.lucene」， 「de.microsoft」， 「de.lucene」， 「 」el.microsoft「， 」el.lucene「， 」gu.microsoft「， 」he.microsoft「， 」hi.microsoft「， 」hi.lucene「， 」hu.microsoft「， 」hu.lucene「， 」is.microsoft「， 」id.microsoft「， 」id.lucene「， 」ga.lucene「， 」it.microsoft「， 」it.lucene「， 」ja.lucene「， 」ja.lucene「， 」kn.microsoft「， 」ko.microsoft「， 」ko.lucene「， 」lv.microsoft「， 」lv.lucene「， 」lt.microsoft「， 」ml.microsoft「， 」ms.microsoft「， 」mr.microsoft「， 」nb.microsoft「， 」no.lucene「， 」fa.lucene「， 」pl.microsoft「， 」pl.lucene「， 」pt-BR.microsoft「， 」pt-BR.lucene「， 」pt-BR.lucene「， 」pt-PT.microsoft「， 」pt-PT.lucene「， 」pa.microsoft「， 」ro.microsoft「， 」ro.lucene「， 」ru.microsoft「， 」ru.lucene「， 」sr-cyrillic.microsoft「， 」sr-latin.microsoft「， 」sk.microsoft「， 」sl.microsoft「， 」es.microsoft「， 」es.lucene「， 」es.lucene「， 」sv.microsoft「， 」sv.lucene「， 」ta.microsoft「， 」te.microsoft「， 」th.microsoft「， 」th.lucene「， 」tr.microsoft「， 」tr.lucene「， 」uk.microsoft「， 」your.microsoft「， 」vi.microsoft「， 」standard.lucene「， 」standardasciifolding.lucene「， 」keyword「， 」pattern「， 」simple「， 」stop「， 」 」空白字元」。
tokenizer_name	str 或 LexicalTokenizerName 用來中斷指定文字的 Tokenizer 名稱。 如果未指定此參數，您必須改為指定分析器。 Tokenizer 和 analyzer 參數互斥。 可能的值包括：「classic」、「edgeNGram」、「keyword_v2」、「letter」、「小寫」、「microsoft_language_tokenizer」、「microsoft_language_stemming_tokenizer」、「nGram」、「path_hierarchy_v2」、「pattern」、「standard_v2」、「uax_url_email」、「空白字元」。
token_filters	list[str 或 TokenFilterName] 中斷指定文字時要使用的選擇性標記篩選清單。 只有在使用 Tokenizer 參數時，才能設定此參數。
char_filters	list[str] 中斷指定文字時要使用的選擇性字元篩選清單。 只有在使用 Tokenizer 參數時，才能設定此參數。

方法

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 JSON 預設會設定 application/xml if 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 JSON 預設會設定 application/xml if 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 相容的物件