HnswParameters クラス
hnsw アルゴリズムに固有のパラメーターが含まれます。
- 継承
-
azure.search.documents.indexes._generated._serialization.ModelHnswParameters
コンストラクター
HnswParameters(*, m: int = 4, ef_construction: int = 400, ef_search: int = 500, metric: str | _models.VectorSearchAlgorithmMetric | None = None, **kwargs: Any)
パラメーター
- m
- int
構築中に新しい要素ごとに作成された双方向リンクの数。 このパラメーター値を大きくすると、メモリ消費量の増加とインデックス作成時間の長さを犠牲にして、組み込み次元が高いデータセットのリコールが向上し、取得時間が短縮される可能性があります。
- ef_construction
- int
インデックス時間中に使用される、最も近い近隣ノードを含む動的リストのサイズ。 このパラメーターを大きくすると、インデックス作成時間の増加を犠牲にして、インデックスの品質が向上する可能性があります。 特定の時点で、このパラメーターを大きくすると、戻り値が減少します。
- ef_search
- int
検索時に使用される、最も近い近隣ノードを含む動的リストのサイズ。 このパラメーターを大きくすると、検索速度が低下する代わりに、検索結果が向上する可能性があります。 特定の時点で、このパラメーターを大きくすると、戻り値が減少します。
- metric
- str または <xref:search_service_client.models.VectorSearchAlgorithmMetric>
ベクター比較に使用する類似性メトリック。 既知の値は、"cosine"、"euclidean"、"dotProduct" です。
変数
- m
- int
構築中に新しい要素ごとに作成された双方向リンクの数。 このパラメーター値を大きくすると、メモリ消費量の増加とインデックス作成時間の長さを犠牲にして、組み込み次元が高いデータセットのリコールが向上し、取得時間が短縮される可能性があります。
- ef_construction
- int
インデックス時間中に使用される、最も近い近隣ノードを含む動的リストのサイズ。 このパラメーターを大きくすると、インデックス作成時間の増加を犠牲にして、インデックスの品質が向上する可能性があります。 特定の時点で、このパラメーターを大きくすると、戻り値が減少します。
- ef_search
- int
検索時に使用される、最も近い近隣ノードを含む動的リストのサイズ。 このパラメーターを大きくすると、検索速度が低下する代わりに、検索結果が向上する可能性があります。 特定の時点で、このパラメーターを大きくすると、戻り値が減少します。
- metric
- str または <xref:search_service_client.models.VectorSearchAlgorithmMetric>
ベクター比較に使用する類似性メトリック。 既知の値は、"cosine"、"euclidean"、"dotProduct" です。
メソッド
as_dict |
json.dump を使用してシリアル化できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。 このファイルの 3 つの例を参照してください。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
deserialize |
RestAPI 構文を使用して str を解析し、モデルを返します。 |
enable_additional_properties_sending | |
from_dict |
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。 既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください |
is_xml_model | |
serialize |
このモデルから Azure に送信される JSON を返します。 これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。 XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
as_dict
json.dump を使用してシリアル化できる dict を返します。
高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。
キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。
このファイルの 3 つの例を参照してください。
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML シリアル化が必要な場合は、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]
パラメーター
- key_transformer
- <xref:function>
キー トランスフォーマー関数。
- keep_readonly
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data: Any, content_type: str | None = None) -> ModelType
パラメーター
戻り値
このモデルのインスタンス
例外
enable_additional_properties_sending
enable_additional_properties_sending() -> None
from_dict
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。
既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、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
パラメーター
- key_extractors
戻り値
このモデルのインスタンス
例外
is_xml_model
is_xml_model() -> bool
serialize
このモデルから Azure に送信される JSON を返します。
これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]
パラメーター
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
Azure SDK for Python
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示