Partager via

FreshnessScoringFunction Classe

  • Référence

Définit une fonction qui augmente les scores en fonction de la valeur d’un champ date-heure.

Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.

Héritage
azure.search.documents.indexes._generated.models._models_py3.ScoringFunction
FreshnessScoringFunction

Constructeur

FreshnessScoringFunction(*, field_name: str, boost: float, parameters: _models.FreshnessScoringParameters, interpolation: str | _models.ScoringFunctionInterpolation | None = None, **kwargs: Any)

Paramètres de mots-clés uniquement

Nom Description
field_name
str

Nom du champ utilisé comme entrée dans la fonction de scoring. Obligatoire.
boost
float

Multiplicateur pour le score brut. Doit être un nombre positif différent de 1,0. Obligatoire.
interpolation
str ou <xref:search_service_client.models.ScoringFunctionInterpolation>

Valeur indiquant comment l’augmentation sera interpolée entre les scores de document ; la valeur par défaut est « Linear ». Les valeurs connues sont : « linéaire », « constant », « quadratique » et « logarithmique ».
parameters
<xref:search_service_client.models.FreshnessScoringParameters>

Valeurs de paramètre pour la fonction de scoring d’actualisation. Obligatoire.

Variables

Nom Description
type
str

Indique le type de fonction à utiliser. Les valeurs autorisées sont magnitude, freshness, distance et tag. Le type de fonction doit être en minuscules. Obligatoire.
field_name
str

Nom du champ utilisé comme entrée dans la fonction de scoring. Obligatoire.
boost
float

Multiplicateur pour le score brut. Doit être un nombre positif différent de 1,0. Obligatoire.
interpolation
str ou <xref:search_service_client.models.ScoringFunctionInterpolation>

Valeur indiquant comment l’augmentation sera interpolée entre les scores de document ; la valeur par défaut est « Linear ». Les valeurs connues sont : « linéaire », « constant », « quadratique » et « logarithmique ».
parameters
<xref:search_service_client.models.FreshnessScoringParameters>

Valeurs de paramètre pour la fonction de scoring d’actualisation. Obligatoire.

Méthodes

as_dict

Retourne un dictée qui peut être sérialisé à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize

Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict

L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Retourne le json qui serait envoyé au serveur à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.

as_dict

Retourne un dictée qui peut être sérialisé à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez une sérialisation XML, vous pouvez passer les 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]

Paramètres

Nom Description
key_transformer
<xref:function>

Fonction de transformateur de clé.
keep_readonly
valeur par défaut: True

Retours

Type Description
dict

Objet compatible JSON de dict

deserialize

Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.

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

Paramètres

Nom Description
data
Obligatoire
str

Str utilisant la structure RestAPI. JSON par défaut.
content_type
str

JSON par défaut, définissez application/xml si XML.

valeur par défaut: None

Retours

Type Description

Une instance de ce modèle

Exceptions

Type Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et 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

Paramètres

Nom Description
data
Obligatoire
dict

Dict utilisant la structure RestAPI
content_type
str

JSON par défaut, définissez application/xml si XML.

valeur par défaut: None
key_extractors
valeur par défaut: None

Retours

Type Description

Une instance de ce modèle

Exceptions

Type Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Retourne le json qui serait envoyé au serveur à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.

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

Paramètres

Nom Description
keep_readonly
bool

Si vous souhaitez sérialiser les attributs readonly

valeur par défaut: False

Retours

Type Description
dict

Objet compatible JSON de dict