パイプラインの実行 (V1)

ノート

特定の pipeline を実行します。

POST/v1/pipeline/{PIPELINE_ID}/run

接続エンドポイント

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘ノート

${CLOUD_REGION} を、デプロイに適したリージョンに置き換える必要があります。
クラウドリージョンIDを取得するには、Zilliz Cloudコンソールまたはクラウドリージョンの一覧を参照してください。

shell

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

パラメータ

Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}

PIPELINE_IDstringpath必要

list-pipelines API endpoint または Zilliz Cloud console から取得した有効な pipeline ID。

値の例： pipe-xxxxxxxxxxxxxxxxx

リクエスト・ボディapplication/json

Ingestion

データ取り込みパラメータ。

dataoneOf必要

(近日追加予定)

オプション 1

doc_urlstring必要

object storage に保存されたドキュメントの URL。エンコードされていない URL、または UTF-8 でエンコードされた URL を使用してください。URL は少なくとも 1 時間有効であることを確認してください。

\{YOUR_PRESERVED_FIELD}string

保持するメタデータフィールド。入力フィールド名は、Ingestion pipeline の作成時に PRESERVE function を追加した際に定義したものと一致している必要があります。このフィールドの値も、事前定義されたフィールド型に従う必要があります。

オプション 2

text_liststring必要

取り込むテキストまたはテキストのリスト。

sourcestring

オプション 3

image_urlstring必要

object storage に保存された画像の URL。エンコードされていない URL、または UTF-8 でエンコードされた URL を使用してください。URL は少なくとも 1 時間有効であることを確認してください。

image_idstring必要

object storage に保存された画像の ID。

image_titlestring必要

画像のタイトル。

dataobject必要

検索データ。

query_textstring

クエリテキスト。Zilliz Cloud はこれを埋め込み、生成されたベクトル埋め込みを使用して対象コレクション内を検索します。これは、SEARCH_TEXT、SEARCH_DOC_CHUNK、または SEARCH_IMAGE_BY_TEXT タイプの pipeline に適用されます。

query_image_urlstring

クエリ画像の URL。これは SEARCH_IMAGE_BY_IMAGE タイプの pipeline に適用されます。

paramsobject必要

検索パラメータ。

limitinteger必要

返されるレコードの総数。

offsetinteger必要

検索結果でスキップするレコードの総数。

outputFieldsarray必要

検索結果の各一致項目について出力するフィールドのリスト。

[]outputFieldsstring

有効な出力フィールドであり、preserve functions で定義されたものである必要があります。

filterstring必要

実際の検索を行う前に Zilliz Cloud がレコードをフィルタリングするためのブール式。

Deletion

dataobject必要

削除リクエストのペイロード。

expressionstring必要

フィルタ式。これは INDEX_TEXT タイプの pipeline に適用されます。

doc_namestring必要

削除するドキュメント名。ドキュメントは名前で削除でき、そのドキュメントのすべての chunk が削除されます。これは INDEX_DOC_CHUNK タイプの pipeline に適用されます。

image_idstring必要

画像の ID。これは INDEX_IMAGE タイプの pipeline に適用されます。

Ingest Text

bash
export TOKEN="YOUR_API_KEY"
export PIPELINE_ID="pipe-xxxxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v1/pipeline/${PIPELINE_ID}/run" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "data": {
        "text_list": [
            "Zilliz Cloud is a fully managed vector database and data services, empowering you to unlock the full potential of unstructured data for your AI applications.",
            "It can store, index, and manage massive embedding vectors generated by deep neural networks and other machine learning (ML) models."
        ],
        "source": "Zilliz official website"
    }
}'

Ingest Document

bash
export TOKEN="YOUR_API_KEY"
export PIPELINE_ID="pipe-xxxxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v1/pipeline/${PIPELINE_ID}/run" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "data": {
        "doc_url": "https://storage.googleapis.com/example-bucket/zilliz_concept_doc.md?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=example%40example-project.iam.gserviceaccount.com%2F20181026%2Fus-central1%2Fstorage%2Fgoog4_request&X-Goog-Date=20181026T181309Z&X-Goog-Expires=900&X-Goog-SignedHeaders=host&X-Goog-Signature=247a2aa45f169edf4d187d54e7cc46e4731b1e6273242c4f4c39a1d2507a0e58706e25e3a85a7dbb891d62afa8496def8e260c1db863d9ace85ff0a184b894b117fe46d1225c82f2aa19efd52cf21d3e2022b3b868dcc1aca2741951ed5bf3bb25a34f5e9316a2841e8ff4c530b22ceaa1c5ce09c7cbb5732631510c20580e61723f5594de3aea497f195456a2ff2bdd0d13bad47289d8611b6f9cfeef0c46c91a455b94e90a66924f722292d21e24d31dcfb38ce0c0f353ffa5a9756fc2a9f2b40bc2113206a81e324fc4fd6823a29163fa845c8ae7eca1fcf6e5bb48b3200983c56c5ca81fffb151cca7402beddfc4a76b133447032ea7abedc098d2eb14a7",
        "publish_year": 2023
    }
}'

Ingest Image

bash
export TOKEN="YOUR_API_KEY"
export PIPELINE_ID="pipe-xxxxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v1/pipeline/${PIPELINE_ID}/run" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "data": {
        "image_id": "my-img-123456",
        "image_url": "xxx",
        "image_title": "A cute yellow cat"
    }
}'

レスポンス200 OK - application/json

特定の pipeline の実行結果を返します。

Ingest Text

json
{
    "code": 200,
    "data": {
        "num_entities": 2,
        "usage": {
            "embedding": 63
        },
        "ids": [
            450524927755105900,
            450524927755105900
        ]
    }
}

Ingest Document

json
{
    "code": 200,
    "data": {
        "doc_name": "zilliz_concept_doc.md",
        "usage": {
            "embedding": 1241
        },
        "num_chunks": 3
    }
}

Ingest Image

json
{
    "code": 200,
    "data": {
        "num_entities": 1,
        "usage": {
            "embedding": 1
        }
    }
}