ScoringProfile Classe

Definisce i parametri per un indice di ricerca che influisce sul punteggio nelle query di ricerca.

Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.

Ereditarietà
azure.search.documents.indexes._generated._serialization.Model
ScoringProfile

Costruttore

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

Parametri solo parole chiave

Nome Descrizione
name
str

Nome del profilo di assegnazione dei punteggi. Obbligatorio.

text_weights
<xref:search_service_client.models.TextWeights>

Parametri che aumentano il punteggio in base alle corrispondenze di testo in determinati campi di indice.

functions
list[<xref:search_service_client.models.ScoringFunction>]

Raccolta di funzioni che influiscono sul punteggio dei documenti.

function_aggregation
str oppure <xref:search_service_client.models.ScoringFunctionAggregation>

Valore che indica come devono essere combinati i risultati delle singole funzioni di assegnazione dei punteggi. Il valore predefinito è "Sum". Ignorato se non sono presenti funzioni di assegnazione dei punteggi. I valori noti sono: "sum", "average", "minimum", "maximum" e "firstMatching".

Variabili

Nome Descrizione
name
str

Nome del profilo di assegnazione dei punteggi. Obbligatorio.

text_weights
<xref:search_service_client.models.TextWeights>

Parametri che aumentano il punteggio in base alle corrispondenze di testo in determinati campi di indice.

functions
list[<xref:search_service_client.models.ScoringFunction>]

Raccolta di funzioni che influiscono sul punteggio dei documenti.

function_aggregation
str oppure <xref:search_service_client.models.ScoringFunctionAggregation>

Valore che indica come devono essere combinati i risultati delle singole funzioni di assegnazione dei punteggi. Il valore predefinito è "Sum". Ignorato se non sono presenti funzioni di assegnazione dei punteggi. I valori noti sono: "sum", "average", "minimum", "maximum" e "firstMatching".

Metodi

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

enable_additional_properties_sending
from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i 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]

Parametri

Nome Descrizione
key_transformer
<xref:function>

Funzione di trasformatore chiave.

keep_readonly
valore predefinito: True

Restituisce

Tipo Descrizione

Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome Descrizione
data
Necessario
str

Str usando la struttura RestAPI. JSON per impostazione predefinita.

content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parametri

Nome Descrizione
data
Necessario

Dict using RestAPI structure

content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None
key_extractors
valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome Descrizione
keep_readonly

Se si vuole serializzare gli attributi readonly

valore predefinito: False

Restituisce

Tipo Descrizione

Oggetto compatibile con JSON dict