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

This operation adds a function, its output field, and the field index to an existing collection in one schema change.

POST/v2/vectordb/collections/add_function_field

接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート

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

shell

export CLUSTER_ENDPOINT=""

パラメータ

Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、またはコロンで連結されたユーザー名とパスワードのペア（例: username:password）である必要があります。プロジェクトエンドポイントを使用している場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例： Bearer {{TOKEN}}

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

dbNamestring

データベースの名前。

collectionNamestring必要

コレクションの名前。

functionobject必要

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

namestring必要

作成する関数の名前。

descriptionstring

作成する関数の説明。

typestring必要

作成する関数のタイプ。

可能な値：

FunctionType.BM25 FunctionType.TEXTEMBEDDING FunctionType.RERANK

inputFieldNamesarray必要

作成する関数の入力フィールドの名前。

[]inputFieldNamesstring

フィールド名。

outputFieldNamesarray必要

作成する関数の出力フィールドの名前。

[]outputFieldNamesstring

フィールド名。

paramsobject

現在の関数に固有の設定パラメーターです。関数タイプが FunctionType.BM25 に設定されている場合、パラメーターは必要ありません。FunctionType.TEXTEMBEDDING または FunctionType.RERANK の関数に適用可能なパラメーターについては、埋め込み関数およびリランキング関数を参照してください。

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

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

elementTypeParamsobject

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

max_lengthinteger

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

diminteger

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

max_capacityinteger

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

externalFieldstring

外部ソース内の対応する列の名前。外部コレクションを作成するときに必須です。

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": "FunctionType.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": {}
}