コレクションに Function フィールドを追加 (V2)

この操作は、1 回のスキーマ変更で、関数、その出力フィールド、およびフィールドインデックスを既存のコレクションに追加します。

POST/v2/vectordb/collections/add_function_field

接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート

• ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
• エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。

shell

export CLUSTER_ENDPOINT=""

パラメータ

Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key または username:password のようにコロンで連結した username と password の組み合わせである必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

値の例： Bearer {{TOKEN}}

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

dbNamestring

データベースの名前。

collectionNamestring必要

コレクションの名前。

functionobject必要

コレクションに追加する関数の定義。

namestring必要

作成する function の名前。

descriptionstring

作成する function の説明。

typestring必要

作成する function のタイプ。

可能な値：

BM25 TEXTEMBEDDING RERANK

inputFieldNamesarray必要

作成する function の入力フィールド名。

[]inputFieldNamesstring

フィールド名。

outputFieldNamesarray必要

作成する function の出力フィールド名。

[]outputFieldNamesstring

フィールド名。

paramsobject

現在の function に固有の構成パラメータ。function type が BM25 に設定されている場合、パラメータは不要です。TEXTEMBEDDING または RERANK の function に適用可能なパラメータについては、Embedding Functions および Reranking Functions を参照してください。

outputFieldobject必要

関数によって生成される出力フィールド。

fieldNamestring必要

対象コレクションに作成するフィールドの名前

dataTypestring必要

フィールド値のデータ型です。

可能な値：

Bool Int8 Int16 Int32 Int64 Float Double VarChar Array Json Geometry BinaryVector FloatVector Float16Vector BFloat16Vector SparseFloatVector Int8Vector

elementDataTypestring

配列フィールド内の要素のデータ型です。現在のフィールドが配列型の場合は必須です。

可能な値：

Bool Int8 Int16 Int32 Int64 Float Double VarChar

nullableboolean

フィールドで null を許可するかどうかです。true に設定すると、フィールドに null 値を含めることができます。

defaultValuestring

フィールドのデフォルト値。現在のフィールドが VarChar 型の場合に必須です。

isPrimaryboolean

現在のフィールドが主フィールドかどうかです。これを True に設定すると、現在のフィールドが主フィールドになります。

isPartitionKeyboolean

現在のフィールドが partition key として機能するかどうか。これを True に設定すると、現在のフィールドが partition key として機能します。この場合、 が現在のコレクション内のすべての partition を管理します。

elementTypeParamsobject

フィールドの追加パラメータです。

max_lengthinteger

現在のフィールドにおける値の最大長を決定する、VarChar 値用のオプションパラメータです。

diminteger

ベクトル次元を決定する、FloatVector または BinaryVector フィールド用のオプションパラメータです。

max_capacityinteger

現在の配列フィールド内の要素の最大数を決定する、Array フィールド値用のオプションパラメータです。

externalFieldstring

外部ソース内の対応する列の名前。external collection を作成する場合に必須です。

indexParamsobject必要

関数の出力フィールドのインデックスパラメータ。

fieldNamestring必要

インデックス化する出力フィールドです。outputField.fieldName と一致する必要があります。

indexNamestring

インデックスの名前。

metricTypestring

インデックスで使用されるメトリック。

可能な値：

BM25

indexTypestring

インデックスのタイプ。

paramsobject

追加のインデックスパラメータ。

index_typestring

関数の出力フィールドに使用されるインデックス実装。

値の例： SPARSE_INVERTED_INDEX

bash

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/add_function_field" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "documents",
    "function": {
        "name": "bm25_fn",
        "type": "BM25",
        "inputFieldNames": [
            "text"
        ],
        "outputFieldNames": [
            "sparse"
        ]
    },
    "outputField": {
        "fieldName": "sparse",
        "dataType": "SparseFloatVector"
    },
    "indexParams": {
        "metricType": "BM25",
        "fieldName": "sparse",
        "indexName": "sparse_index",
        "params": {
            "index_type": "SPARSE_INVERTED_INDEX"
        }
    }
}'

レスポンス200 OK - application/json

空のオブジェクトを返します。

Success

codeinteger

レスポンスコード。

dataobject

Failure

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson

{
    "code": 0,
    "data": {}
}