Help Center> Cloud Search Service> API Reference> APIs Related to Word Dictionary Management> Poisson Word Segmentation (Version 6.2.3)> Querying the Word Dictionary Status
View PDF

Querying the Word Dictionary Status

Function

This API is used to query the loading status of a custom word dictionary.

URI

  • URI format 
    GET /v1.0/{project_id}/clusters/{cluster_id}/poisson_words
  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details, see Obtaining the Project ID and Account ID.

    cluster_id

    Yes

    String

    ID of the cluster where the word dictionary status is queried.

Request

None

Response

Table 1 Parameter description

Parameter

Type

Description

id

String

ID of the word dictionary.

clusterId

String

Cluster ID.

wordType

String

Type of the word dictionary. Currently, the following three types are supported:

  • MainWord: Indicates the main word dictionary.
  • StopWord: Indicates the stop word dictionary.
  • SynonymWord: Indicates the synonym word dictionary.

uploadTime

String

Time when the word dictionary is uploaded.

name

String

Name of the word dictionary.

uploadStatus

String

Uploading status of the word dictionary.

Failed indicates that a custom word dictionary fails to be uploaded.

Loading indicates that a custom word dictionary is being loaded.

Succeed indicates that a custom word dictionary is successfully uploaded.

Examples

Example request

GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/poisson_words

Example response

"results": [
        {
            "id": "a8abc4c6-3761-4909-9f85-cf2b0c815b75",
            "clusterId": "c3fed09a-58fb-4a60-be63-ba470f7e7b1b",
            "wordType": "MainWord",
            "uploadTime": "1554870705000",
            "name": "main.txt",
            "uploadStatus": "Loading"
        }
    ]

Status Code

Table 2 describes the status code.

Table 2 Status code

Status Code

Code

Description

200

OK

The request is processed successfully.

400

BadRequest

Invalid request.

The client should not repeat the request without modifications.

500

InternalServerError

The server is able to receive the request but it could not understand the request.