ScoringProfile Klas

Hiermee definieert u parameters voor een zoekindex die van invloed zijn op het scoren in zoekquery's.

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

Overname

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

ScoringProfile

Constructor

ScoringProfile(*, name: str, text_weights: _models.TextWeights | None = None, functions: List[_models.ScoringFunction] | None = None, function_aggregation: str | _models.ScoringFunctionAggregation | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
name	str De naam van het scoreprofiel. Vereist.
text_weights	<xref:search_service_client.models.TextWeights> Parameters die het scoren verbeteren op basis van tekstovereenkomsten in bepaalde indexvelden.
functions	list[<xref:search_service_client.models.ScoringFunction>] De verzameling functies die van invloed zijn op het scoren van documenten.
function_aggregation	str of <xref:search_service_client.models.ScoringFunctionAggregation> Een waarde die aangeeft hoe de resultaten van afzonderlijke scorefuncties moeten worden gecombineerd. De standaardwaarde is 'Som'. Genegeerd als er geen scorefuncties zijn. Bekende waarden zijn: 'sum', 'average', 'minimum', 'maximum' en 'firstMatching'.

Variabelen

Name	Description
name	str De naam van het scoreprofiel. Vereist.
text_weights	<xref:search_service_client.models.TextWeights> Parameters die het scoren verbeteren op basis van tekstovereenkomsten in bepaalde indexvelden.
functions	list[<xref:search_service_client.models.ScoringFunction>] De verzameling functies die van invloed zijn op het scoren van documenten.
function_aggregation	str of <xref:search_service_client.models.ScoringFunctionAggregation> Een waarde die aangeeft hoe de resultaten van afzonderlijke scorefuncties moeten worden gecombineerd. De standaardwaarde is 'Som'. Genegeerd als er geen scorefuncties zijn. Bekende waarden zijn: 'sum', 'average', 'minimum', 'maximum' en 'firstMatching'.

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