[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Run Analyzer (V2)

This operation runs an analyzer on the provided text and returns the tokenization result.

POST/v2/vectordb/common/run_analyzer

Connection Endpoint

Cluster EndpointProject Endpoint (On-Demand)

The base URL for this API is in the following format:

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘Notes

• Use the cluster endpoint if you are using serving clusters.

  • Free & Serverless

    https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

  • Dedicated

    https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

• You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
• To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.

export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password. If you are using a project endpoint, only a valid API key with sufficient permissions applies.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestring

The name of the database.

textarrayrequired

A list of text strings to analyze.

[]textstring

(To be added soon)

analyzerParamsstring

The analyzer parameters as a JSON string.

withDetailboolean

Whether to return detailed token information.

withHashboolean

Whether to include hash values in the result.

collectionNamestring

The name of the collection whose field analyzer to use.

fieldNamestring

The name of the field whose analyzer to use.

analyzerNamesarray

A list of analyzer names to use.

[]analyzerNamesstring

(To be added soon)

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/common/run_analyzer" \
--header "Authorization: Bearer ${TOKEN}". \
--header "Request-Timeout: 10" \
--header "Content-Type: application/json" \
-d '{
    "text": [
        "Hello world"
    ],
    "analyzerParams": "{\"type\": \"standard\"}",
    "withDetail": false
}'

Responses200 - application/json

SUCCESS

codeinteger

(To be added soon)

dataarray

[]dataobject

tokensarray

[]tokensstring

(To be added soon)

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": [
        {
            "tokens": [
                "hello",
                "world"
            ]
        }
    ]
}