更新时间:2024-07-03 GMT+08:00
分享

加载自定义词库

功能介绍

该接口用于加载存放于OBS的自定义词库。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID和名称

cluster_id

String

指定配置自定义词库的集群ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bucketName

String

词库文件存放的OBS桶(桶类型必须为标准存储或者低频存储,不支持归档存储)。

mainObject

String

主词库文件对象,必须为UTF-8无BOM编码的文本文件,一行一个分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

stopObject

String

停词词库文件对象,必须为UTF-8无BOM编码的文本文件,一行一个分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

synonymObject

String

同义词词库文件,必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。

static_main_object

String

预置主词词库文件,必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

static_stop_object

String

预置停词词库文件,必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

extra_main_object

String

Extra主词词库文件,必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

extra_stop_object

String

Extra停词词库文件,必须为UTF-8无BOM编码的文本文件,一行一组分词,文件大小最大支持100M。 7个词库参数至少修改一个词库。注:参数传递""空字符串为清空此词库,不传或传递null为不修改。仅支持此词库功能上线后的新集群。

响应参数

请求示例

开启并配置词库信息。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/thesaurus

{
  "bucketName" : "test-bucket",
  "mainObject" : "word/main.txt",
  "stopObject" : "word/stop.txt",
  "synonymObject" : "word/synonym.txt",
  "static_main_object" : "word/staticMain.txt",
  "static_stop_object" : "word/staticStop.txt",
  "extra_main_object" : "word/extraMain.txt",
  "extra_stop_object" : "word/extraStop.txt"
}

响应示例

SDK代码示例

SDK代码示例如下。

开启并配置词库信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;


public class CreateLoadIkThesaurusSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateLoadIkThesaurusRequest request = new CreateLoadIkThesaurusRequest();
        LoadCustomThesaurusReq body = new LoadCustomThesaurusReq();
        body.withSynonymObject("word/synonym.txt");
        body.withStopObject("word/stop.txt");
        body.withMainObject("word/main.txt");
        body.withBucketName("test-bucket");
        request.withBody(body);
        try {
            CreateLoadIkThesaurusResponse response = client.createLoadIkThesaurus(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

开启并配置词库信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateLoadIkThesaurusRequest()
        request.body = LoadCustomThesaurusReq(
            synonym_object="word/synonym.txt",
            stop_object="word/stop.txt",
            main_object="word/main.txt",
            bucket_name="test-bucket"
        )
        response = client.create_load_ik_thesaurus(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

开启并配置词库信息。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateLoadIkThesaurusRequest{}
	synonymObjectLoadCustomThesaurusReq:= "word/synonym.txt"
	stopObjectLoadCustomThesaurusReq:= "word/stop.txt"
	mainObjectLoadCustomThesaurusReq:= "word/main.txt"
	request.Body = &model.LoadCustomThesaurusReq{
		SynonymObject: &synonymObjectLoadCustomThesaurusReq,
		StopObject: &stopObjectLoadCustomThesaurusReq,
		MainObject: &mainObjectLoadCustomThesaurusReq,
		BucketName: "test-bucket",
	}
	response, err := client.CreateLoadIkThesaurus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功。

403

请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

表明服务端能被请求访问到,但是不能理解用户的请求。

错误码

请参见错误码

相关文档