add_file_resource()

内测版

将已上传到 Milvus 集群所配置对象存储中的文件注册为具名文件资源。注册后，可通过 {"type": "remote", "resource_name": "<name>", "file_name": "<file_name>"} 在接受外部词典的 Analyzer 参数中引用该资源，例如 jieba tokenizer 上的 extra_dict_file、stop filter 上的 stop_words_file、decompounder filter 上的 word_list_file，以及 synonym filter 上的 synonyms_file。目标文件在本次调用时必须已存在于对象存储中；服务器会同步验证 path，如果无法解析，则请求将失败。

请求语法

python

add_file_resource(
    name: str,
    path: str,
    timeout: float | None = None,
    **kwargs
)

参数：

• name （str） -
  用于注册该资源的唯一名称。后续在引用此资源的 Analyzer 配置中，您需要将此值作为 resource_name 传入。

• path （str） -
  Milvus 集群所配置对象存储中该文件的对象键，包括 rootPath 前缀。例如，如果集群的 rootPath 为 file，而您将文件上传到了 s3://<bucket>/file/dict.txt，请将 path 设置为 "file/dict.txt"。如果该路径无法解析为现有对象，此调用将因 MilvusException 而失败（code=65535、message="file resource path not exist"）。

• timeout （float | None） -
  此操作的超时时长（以秒为单位）。值为 None 表示不应用超时。

返回：

None

示例

python

from pymilvus import MilvusClient

client = MilvusClient(
    uri="YOUR_CLUSTER_ENDPOINT",
    token="YOUR_CLUSTER_TOKEN",
)

# Upload the file to the cluster's object store out-of-band first
# (e.g., via mc, boto3, or the AWS CLI), then register it here.
client.add_file_resource(
    name="zh_terms",
    path="file/zh_terms.txt",
)

# The registered resource can now be referenced from analyzer configs.
analyzer_params = {
    "tokenizer": {
        "type": "jieba",
        "dict": ["_default_"],
        "extra_dict_file": {
            "type": "remote",
            "resource_name": "zh_terms",
            "file_name": "zh_terms.txt",
        },
    },
}