大規模モデルサービスをサービスプラットフォームに登録して一元管理できます。これにより、さまざまなアプリケーションからのモデル呼び出しに関する統計を収集し、モデル API のレート制限を設定し、API を監視し、呼び出しログを表示できます。このトピックでは、モデルに基づく API の作成方法について説明します。
ステップ 1: API の作成方法の選択
Dataphin ホームページの上部のメニューバーで、[サービス] > [API 開発] を選択します。
左上隅で、サービスプロジェクトを選択します。左側のナビゲーションウィンドウで、[API サービス] をクリックします。API ページで、[+ 新しい API] ボタンをクリックします。
[新しい API] ダイアログボックスで、[モデル API] を選択します。
ステップ 2: モデル API のパラメーターの設定
[新しい API] ページで、パラメーターを設定します。
パラメーター
説明
基本情報
API 名
API の名前を入力します。命名規則は次のとおりです。
名前に使用できるのは、漢字、文字、数字、アンダースコア (_) のみです。
名前の長さは 4 ～ 100 文字である必要があります。
名前は文字で始まる必要があります。
名前はグローバルに一意である必要があります。
モデル
モデルの名前を入力します。名前は 256 文字を超えることはできません。
プロトコルタイプ
API のプロトコルを選択します。[OpenAI 互換] と [DashScope] を選択できます。
操作タイプ
デフォルト値は [GET] です。このパラメーターは変更できません。
[GET]: サーバーから特定のリソースをリクエストします。
API グループ
現在のプロジェクトで構成されている API グループを選択します。作成するには、「サービスグループの作成」をご参照ください。
説明
API の簡単な説明を入力します。説明は 128 文字以内で入力してください。
プロトコル
データ生成 API のプロトコルです。サポートされているプロトコルは HTTP と HTTPS です。
HTTP: Hypertext Transfer Protocol (HTTP) は、最も広く使用されているネットワークプロトコルです。
HTTPS: ゲートウェイが Alibaba Cloud API Gateway インスタンス (専用または共有) の場合は、HTTPS を選択できます。API 呼び出しを成功させるには、独立ドメインの SSL 証明書が有効であることを確認してください。SSL 証明書を構成するには、[プラットフォーム管理ネットワーク構成] を選択し、[ネットワーク構成] ページに移動します。
呼び出しモード
クライアントとサーバー間の通信で、データを取得または処理するために使用されます。同期呼び出しまたは非同期呼び出しを選択できます。デフォルトは同期呼び出しです。
同期呼び出し: クライアントがリクエストを送信した後、他のリクエストを送信する前にサーバーが結果を返すのを待つ必要があります。複雑なクエリ文の場合、応答時間が長くなり、待機中にサーバー接続が占有されます。これにより、サーバーの負荷が増加します。このモードは、高いリアルタイム性能と短い処理時間を必要とするシナリオに適しています。
[非同期呼び出し]: クライアントがリクエストを送信した後、サーバーの応答を待つ必要はなく、他のリクエストを送信し続けることができます。サーバーは、処理が完了した後にクライアントに通知します。バッチでデータを取得する場合、このモードはデータベースクエリ結果の重複率を減らし、DataService Studio API を使用してデータを取得できます。このモードは、バッチ処理など、処理時間が長く、リアルタイム要件が低いシナリオに適しています。
実行タイムアウト
このパラメーターは、呼び出しモードが非同期の場合に使用できます。SQL 実行時間をモニターするために使用されます。デフォルト値は 60 秒です。1 から 7,200 (2 時間) までの整数に設定できます。
タイムアウト
API 呼び出しの最大期間。呼び出しモードが同期の場合、デフォルト値は 30 秒です。3 から 60 までの整数に設定できます。呼び出しモードが非同期の場合、デフォルト値は 600 秒です。3 から 7,200 (2 時間) までの整数に設定できます。
API 呼び出しが設定されたタイムアウト期間を超えると、エラーが報告され、例外を迅速に検出して処理するのに役立ちます。例外の表示に関する詳細については、「サービスモニタリング API の表示と管理」をご参照ください。
バージョン番号
API のバージョン番号を入力します。各構成には、前のバージョンと比較するためのバージョン番号があります。バージョン番号は最大 64 文字で、API に対して一意である必要があります。
戻り値の型
デフォルト値は JSON です。
バックエンドサービス構成
モード
[基本] または [Dev_Prod] モードを選択できます。
基本モードでは、開発、送信、公開中に本番データベースが読み取られます。
Dev-Prod モードでは、開発および送信中に開発者データベースが読み取られ、公開後に本番データベースが読み取られます。
リクエストメソッド
バックエンドサービスに呼び出しを転送するために使用されるリクエストメソッド。POST のみがサポートされています。
[POST]: POST を選択した場合、リクエストパラメーターに BODY を選択できます。
API データソース
API のデータソースを選択します。データソースを作成するには、「API データソースの作成」をご参照ください。
サービスタイムアウト
バックエンドサービスへの転送呼び出しの期間を監視します。バックエンドサービスへの呼び出しが設定された [サービスタイムアウト] 期間を超えると、API 呼び出しはタイムアウトエラーを報告します。これにより、API 呼び出しの例外を迅速に検出して処理できます。例外の表示方法の詳細については、「サービス監視 API の表示と管理」をご参照ください。
サービスパス
サービスパスは、プロトコルタイプとモデルタイプによって決まります。プロトコルタイプが OpenAI 互換の場合、サポートされるモデルタイプはチャットとカスタムです。プロトコルタイプが DashScope の場合、サポートされるモデルタイプはチャット、画像生成、カスタムです。モデルタイプを選択すると、対応するサービスパスがシステムに表示されます。
たとえば、API データソースの URL が
http://dashscope.aliyuncs.com:*****/api/exampleで、サービスパスが/compatible-mode/v1/chat/completionsの場合、バックエンドサービスの完全な URL はhttp://dashscope.aliyuncs.com:*****/api/example/compatible-mode/v1/chat/completionsです。カスタムサービスパスを選択する場合、パスはスラッシュ (/) で始まり、128 文字を超えることはできません。
リクエストパラメーター
パラメーター名
ユーザーが API にアクセスするときに直接使用するパブリックパラメーター。名前は最大 128 文字です。
パラメーターの場所
ヘッダー、パラメーター、または本文を選択できます。
[ヘッダー]: リクエストパラメーターの解析中にパラメーターがヘッダーに追加されます。
[パラメーター]: リクエストパラメーターの解析中にパラメーターがデータソース URL に追加されます。
[本文]: 複数のパラメーターがある場合、リクエストパラメーターの解析中に本文にカプセル化されます。
パラメータータイプ
パラメーターの場所がヘッダーまたはパラメーターに設定されている場合、サポートされるパラメーターの型は DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、および BIGDECIMAL です。バインドされたフィールドに対応するパラメーターの型を選択します。
パラメーターの場所がボディに設定されている場合、前述の型に加えて、Array(int)、Array(string)、Object、Array(double)、Array(float)、Array(Date(yyyy-MM-dd HH:mm:ss))、Array(boolean)、Array(long)、Array(short)、Array(BigDecimal)、および Array(Object) がサポートされます。
デフォルト値
バックエンドサービス呼び出し中に値が渡されない場合、デフォルト値が使用されます。最大 1,000 文字まで入力できます。パラメータータイプが STRING の場合、文字数制限はありません。
例
開発者が理解しやすいように、リクエストパラメーターのサンプル値を入力します。最大 1,000 文字まで入力できます。
説明
リクエストパラメーターの簡単な説明を入力します。最大 1,000 文字まで入力できます。
必須
このパラメーターが必須で、API 呼び出し中に値が渡されない場合、呼び出しは失敗します。
テスト
テストを実行して、大規模モデルからの応答が期待どおりであるかどうかを確認できます。
リクエストパラメーターを設定した後、[テスト] ボタンをクリックします。[テストリクエストの送信] ダイアログボックスで、リクエストパラメーターの試用値を入力し、[テストの開始] ボタンをクリックします。システムはリクエストパラメーターをカプセル化し、リクエスト本文を大規模モデルに送信して、応答を返します。
スマート追加
この操作は、操作タイプが GET で、リクエストパラメーターをテストした場合に使用できます。[スマート追加] ボタンをクリックします。システムは応答結果から第一層のパラメーターを自動的に抽出し、応答パラメーターリストにそれらを埋め込みます。これには、パラメーター名、応答パラメーター値のパス、およびパラメーターの型が含まれます。
レスポンスパラメーター
パラメーター名
必須。API によってユーザーに返されるパブリックパラメーター名です。名前は最大 128 文字です。
レスポンスパラメーター値のパス
JSON フォーマットのみがサポートされています。返されたデータが複数のレイヤーにネストされている場合は、対応するレスポンスパラメーターパスを設定する必要があります。[構成手順の表示] をクリックして、例に基づいてレスポンスパラメーターの値パスを設定するか、キーワードを入力して一致するパスを検索できます。
パラメータータイプ
レスポンスパラメーター値のパスがテストされている場合、システムはテスト結果に基づいてデータ型を自動的に検出します。パラメーター名に対応するバインドされたフィールドのパラメーターの型を選択できます。サポートされている型には、DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BIGDECIMAL、Array(int)、Array(string)、Object、Array(double)、Array(float)、Array(Date(yyyy-MM-dd HH:mm:ss))、Array(boolean)、Array(long)、Array(short)、Array(BigDecimal)、および Array(Object) が含まれます。
例
開発者が理解しやすいように、レスポンスパラメーターのサンプル値を入力します。最大 1,000 文字まで入力できます。
説明
レスポンスパラメーターの簡単な説明を入力します。最大 1,000 文字まで入力できます。
[送信] をクリックして API を作成します。
次のステップ
API を生成した後、アプリケーションから呼び出せるように、テストして DataService Studio マーケットプレイスに公開する必要があります。詳細については、「API のテストと公開」をご参照ください。
API の削除、バージョンの管理、または所有権の移管については、「API の表示と管理」をご参照ください。