EmbeddingsUnitTests

class langchain_tests.unit_tests.embeddings.EmbeddingsUnitTests

嵌入单元测试的基类。

测试子类必须实现embeddings_class属性以指定要测试的嵌入模型。你也可以重写embedding_model_params属性以指定初始化参数。

示例：

from typing import Type

from langchain_tests.unit_tests import EmbeddingsUnitTests
from my_package.embeddings import MyEmbeddingsModel


class TestMyEmbeddingsModelUnit(EmbeddingsUnitTests):
    @property
    def embeddings_class(self) -> Type[MyEmbeddingsModel]:
        # Return the embeddings model class to test here
        return MyEmbeddingsModel

    @property
    def embedding_model_params(self) -> dict:
        # Return initialization parameters for the model.
        return {"model": "model-001"}

注意

个别测试方法的API参考包括故障排除提示。

Testing initialization from environment variables

覆盖init_from_env_params属性将启用从环境变量初始化的额外测试。详情请见下文。

init_from_env_params

此属性用于单元测试中，以测试从环境变量进行的初始化。它应返回三个字典的元组，这些字典指定了环境变量、额外的初始化参数以及要检查的预期实例属性。

默认为空字典。如果未覆盖，则跳过测试。

示例：

@property
def init_from_env_params(self) -> Tuple[dict, dict, dict]:
    return (
        {
            "MY_API_KEY": "api_key",
        },
        {
            "model": "model-001",
        },
        {
            "my_api_key": "api_key",
        },
    )

属性

embedding_model_params
embeddings_class
init_from_env_params	此属性用于单元测试中，以测试从环境变量初始化的功能。

方法

model()
test_init()	测试模型初始化。
test_init_from_env()	测试从环境变量初始化。

model() → Embeddings

Return type:

Embeddings

test_init() → None

测试模型初始化。

Troubleshooting

如果此测试失败，请确保指定了embedding_model_params并且可以从这些参数初始化模型。

Return type:

无

test_init_from_env() → None

测试从环境变量初始化。依赖于init_from_env_params属性。如果未设置该属性，则跳过测试。

Troubleshooting

如果此测试失败，请确保正确指定了init_from_env_params，并且在初始化期间从环境变量中正确设置了模型参数。

Return type:

无