ShingleTokenFilter Klas

Hiermee maakt u combinaties van tokens als één token. Dit tokenfilter wordt geïmplementeerd met apache Lucene.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname

azure.search.documents.indexes._generated.models._models_py3.TokenFilter

ShingleTokenFilter

Constructor

ShingleTokenFilter(*, name: str, max_shingle_size: int = 2, min_shingle_size: int = 2, output_unigrams: bool = True, output_unigrams_if_no_shingles: bool = False, token_separator: str = ' ', filter_token: str = '_', **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str De naam van het tokenfilter. Het mag alleen letters, cijfers, spaties, streepjes of onderstrepingstekens bevatten, mag alleen beginnen en eindigen met alfanumerieke tekens en is beperkt tot 128 tekens. Vereist.
max_shingle_size	int De maximale shingle-grootte. De standaardwaarde en de minimumwaarde is 2. standaardwaarde: 2
min_shingle_size	int De minimale grootte van de gordelroos. De standaardwaarde en de minimumwaarde is 2. Moet kleiner zijn dan de waarde van maxShingleSize. standaardwaarde: 2
output_unigrams	bool Een waarde die aangeeft of de uitvoerstroom de invoertokens (unigrammen) en shingles bevat. De standaardwaarde is true. standaardwaarde: True
output_unigrams_if_no_shingles	bool Een waarde die aangeeft of unigrammen moeten worden uitgevoerd wanneer er geen gordelroos beschikbaar is. Deze eigenschap heeft voorrang wanneer outputUnigrams is ingesteld op false. De standaardinstelling is onwaar.
token_separator	str De tekenreeks die moet worden gebruikt bij het samenvoegen van aangrenzende tokens om een shingle te vormen. De standaardwaarde is één spatie (" "). standaardwaarde:
filter_token	str De tekenreeks die moet worden ingevoegd voor elke positie waarop er geen token is. De standaardwaarde is een onderstrepingsteken ("_"). standaardwaarde: _

Variabelen

Name	Description
odata_type	str Een URI-fragment dat het type tokenfilter aangeeft. Vereist.
name	str De naam van het tokenfilter. Het mag alleen letters, cijfers, spaties, streepjes of onderstrepingstekens bevatten, mag alleen beginnen en eindigen met alfanumerieke tekens en is beperkt tot 128 tekens. Vereist.
max_shingle_size	int De maximale shingle-grootte. De standaardwaarde en de minimumwaarde is 2.
min_shingle_size	int De minimale grootte van de gordelroos. De standaardwaarde en de minimumwaarde is 2. Moet kleiner zijn dan de waarde van maxShingleSize.
output_unigrams	bool Een waarde die aangeeft of de uitvoerstroom de invoertokens (unigrammen) en shingles bevat. De standaardwaarde is true.
output_unigrams_if_no_shingles	bool Een waarde die aangeeft of unigrammen moeten worden uitgevoerd wanneer er geen gordelroos beschikbaar is. Deze eigenschap heeft voorrang wanneer outputUnigrams is ingesteld op false. De standaardinstelling is onwaar.
token_separator	str De tekenreeks die moet worden gebruikt bij het samenvoegen van aangrenzende tokens om een shingle te vormen. De standaardwaarde is één spatie (" ").
filter_token	str De tekenreeks die moet worden ingevoegd voor elke positie waarop er geen token is. De standaardwaarde is een onderstrepingsteken ("_").

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren. Bekijk de drie voorbeelden in dit bestand: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.
enable_additional_properties_sending
from_dict	Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourneert de JSON die vanuit dit model naar de server wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

as_dict

Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

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]

Parameters

Name	Description
key_transformer	<xref:function> Een sleuteltransformatorfunctie.
keep_readonly	standaardwaarde: True

Retouren

Type	Description
dict	Een dict JSON-compatibel object

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

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

Parameters

Name	Description
data Vereist	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en 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

Parameters

Name	Description
data Vereist	dict Een dict met behulp van de RestAPI-structuur
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None
key_extractors	standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retourneert de JSON die vanuit dit model naar de server wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

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

Parameters

Name	Description
keep_readonly	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object