CreateFunctionInstance API による OpenSearch アルゴリズムインスタンスの構築 - OpenSearch

機能のアルゴリズムインスタンスを作成します。

操作説明

GetFunctionCurrentVersion 操作を呼び出して、機能の最新バージョンを照会できます。この操作の応答には、アルゴリズムインスタンスの作成に使用される createParameters パラメーター、usageParameters パラメーター、およびこれらのパラメーターを設定するための要件が含まれます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

opensearch:WriteFunction

create

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

なし

リクエスト構文

POST /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーションの名前。	my_app_group_name
functionName	string	必須	機能名。有効な値： ctr：CTR モデル。 pop：人気度モデル。 category：カテゴリモデル。 hot：ホットワードモデル。 hint：ヒントワードモデル。 suggest：検索候補モデル。 analyzer：トークン化モデル。 termweight：term 重みモデル。 synonym：シノニムモデル。	ctr

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Body	object	任意	リクエストボディ。	{ "instanceName": "ctr_test", "modelType": "tf_checkpoint", "createParameters": [ { "name": "title_field", "value": "title" }, { "name": "description_field", "value": "" }, { "name": "tags_field", "value": "" }, { "name": "id_field", "value": "item_id" }, { "name": "category_field", "value": "cate" } ], "description": "测试实例", }
instanceName	string	必須	インスタンス名。名前は 1～30 文字で、英字、数字、アンダースコア (_) を使用できます。名前は大文字と小文字を区別し、英字で始まる必要があります。	ctr_test
modelType	string	必須	モデルタイプ。値はモデルによって異なります。クリックスルー率 (CTR) モデル：tf_checkpoint 人気度モデル：pop カテゴリモデル：offline_inference ホットワードモデル：offline_inference ヒントワードモデル：offline_inference リアルタイムトップ検索のホットワードモデル：near_realtime パーソナライズされたヒントワードモデル：near_realtime 検索候補モデル：offline_inference トークン化モデル：text term 重みモデル：tf_checkpoint シノニムモデル：offline_inference	tf_checkpoint
functionType	string	任意	機能タイプ。デフォルト値：PAAS。この機能を使用する前にトレーニングが必要です。	PAAS
description	string	任意	説明。	测试实例
createParameters	array<object>	任意	インスタンスの作成に使用されるパラメーター。	[ { "name": "param1", "value": "val1" } ]
	object	任意	パラメーターの本文。	{ "name": "title_field", "value": "title" }
name	string	任意	パラメーター名。	title_field
value	string	任意	パラメーター値。	title
usageParameters	array<object>	任意	インスタンスの使用に使用されるパラメーター。
	object	任意	ブラックリストやホワイトリストなど、オンラインで使用されるパラメーター。
name	string	任意	パラメーター名。	allow_dict_id
value	string	任意	パラメーター値。	123
cron	string	任意	定期的なトレーニングをスケジュールするための CRON 式。フォーマットは「分時日月曜日」です。デフォルト値は空で、定期的なトレーニングが実行されないことを示します。曜日の値 0 は日曜日を示します。	0 0 ? * 0,1,2,3,4,5,6

リクエスト例 (この例では、functionName パラメーターは ctr に設定されています。)

POST /v4/openapi/app-groups/my-app/functions/ctr/instances
{
    "instanceName": "my_ctr",
    "modelType": "tf_checkpoint",
    "functionType": "PAAS",
    "cron": "0 0 ? * 0,1,3,5",
    "description": "",
    "createParameters": [
        {
            "name": "id_field",
            "value": "id"
        },
        {
            "name": "title_field",
            "value": "title"
        }
    ],
    "usageParameters": []
}

リクエスト例 (この例では、functionName パラメーターは hot に設定されています。)

POST /v4/openapi/app-groups/my-app/functions/hot/instances
{
    "instanceName":"my_hot",
    "modelType":"offline_inference",
    "functionType":"PAAS",
    "createParameters":[
        {
            "name":"filter",
            "value":"biz_type != 1"
        }
    ],
    "usageParameters": [
        {
            "name":"allow_dict_id",
            "value":"123"
        },
        {
            "name":"deny_dict_id",
            "value":"456"
        }
    ],
    "cron":"12 4 ? * 1,2,3,4,5,6,0"
}

レスポンスフィールド

フィールド	型	説明	例
	object	パラメーターの本文。	{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }
Status	string	リクエストのステータス。	OK
HttpCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	98724351-D6B2-5D8A-B089-7FFD1821A7E9
Message	string	エラーメッセージ。エラーが発生しない場合、このパラメーターは空のままです。	version not exist.
Code	string	エラーコード。	Version.NotExist
Latency	integer	リクエストの消費時間 (ミリ秒)。	123

正常なレスポンスの例

{
  "status" : "OK",
  "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency" : 123,
  "result" : {}
}

例

成功レスポンス

JSONJSON

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "Message": "version not exist.",
  "Code": "Version.NotExist",
  "Latency": 123
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。