HnswParameters Classe
Contient les paramètres spécifiques à l’algorithme HNSW.
- Héritage
-
azure.search.documents.indexes._generated._serialization.ModelHnswParameters
Constructeur
HnswParameters(*, m: int = 4, ef_construction: int = 400, ef_search: int = 500, metric: str | _models.VectorSearchAlgorithmMetric | None = None, **kwargs: Any)Paramètres de mots-clés uniquement
| Nom | Description |
|---|---|
|
m
|
Nombre de liens bidirectionnels créés pour chaque nouvel élément pendant la construction. L’augmentation de cette valeur de paramètre peut améliorer le rappel et réduire les temps de récupération des jeux de données à dimensionnalité intrinsèque élevée, au détriment d’une consommation de mémoire accrue et d’un temps d’indexation plus long. valeur par défaut: 4
|
|
ef_construction
|
Taille de la liste dynamique contenant les voisins les plus proches, qui est utilisée pendant l’heure d’index. L’augmentation de ce paramètre peut améliorer la qualité de l’index, au détriment de l’augmentation du temps d’indexation. À un moment donné, l’augmentation de ce paramètre entraîne une diminution des rendements. valeur par défaut: 400
|
|
ef_search
|
Taille de la liste dynamique contenant les voisins les plus proches, qui est utilisée pendant le temps de recherche. L’augmentation de ce paramètre peut améliorer les résultats de recherche, au détriment d’une recherche plus lente. À un moment donné, l’augmentation de ce paramètre entraîne une diminution des rendements. valeur par défaut: 500
|
|
metric
|
str ou
<xref:search_service_client.models.VectorSearchAlgorithmMetric>
Métrique de similarité à utiliser pour les comparaisons de vecteurs. Les valeurs connues sont : « cosinus », « euclidien » et « dotProduct ». |
Variables
| Nom | Description |
|---|---|
|
m
|
Nombre de liens bidirectionnels créés pour chaque nouvel élément pendant la construction. L’augmentation de cette valeur de paramètre peut améliorer le rappel et réduire les temps de récupération des jeux de données à dimensionnalité intrinsèque élevée, au détriment d’une consommation de mémoire accrue et d’un temps d’indexation plus long. |
|
ef_construction
|
Taille de la liste dynamique contenant les voisins les plus proches, qui est utilisée pendant l’heure d’index. L’augmentation de ce paramètre peut améliorer la qualité de l’index, au détriment de l’augmentation du temps d’indexation. À un moment donné, l’augmentation de ce paramètre entraîne une diminution des rendements. |
|
ef_search
|
Taille de la liste dynamique contenant les voisins les plus proches, qui est utilisée pendant le temps de recherche. L’augmentation de ce paramètre peut améliorer les résultats de recherche, au détriment d’une recherche plus lente. À un moment donné, l’augmentation de ce paramètre entraîne une diminution des rendements. |
|
metric
|
str ou
<xref:search_service_client.models.VectorSearchAlgorithmMetric>
Métrique de similarité à utiliser pour les comparaisons de vecteurs. Les valeurs connues sont : « cosinus », « euclidien » et « dotProduct ». |
Méthodes
| as_dict |
Retourne un dict 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 une 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 de cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
| deserialize |
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle. |
| enable_additional_properties_sending | |
| from_dict |
Analyser une 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 la sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
as_dict
Retourne un dict 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 une 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 de cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il 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 la 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 |
|---|---|
|
Objet compatible JSON dict |
deserialize
Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data: Any, content_type: str | None = None) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
Str utilisant la structure RestAPI. JSON par défaut. |
|
content_type
|
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() -> Nonefrom_dict
Analyser une 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) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
dict utilisant la structure RestAPI |
|
content_type
|
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() -> boolserialize
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 la 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
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
| Type | Description |
|---|---|
|
Objet compatible JSON dict |
Azure SDK for Python