APIまたはSDKを使用してOpenSearch LLM-Based Conversational Search Editionにアクセスするには、認証が必要です。このトピックでは、OpenSearch LLM-Based Conversational Search Editionによる認証と承認の方法、およびAPIキーの管理方法について説明します。
API呼び出しの承認
OpenSearch LLM-Based Conversational Search Editionは、APIキーを使用してAPI呼び出しを承認します。 各インスタンスにつき、最大10個のAPIキーを作成して有効化できます。
APIキーを保護するために、以下を行ってください。
APIキーを公開しないでください。これは、不正使用によるセキュリティリスクや金銭的損失を防ぎます。
すべてのAPI呼び出しがサーバーからのみ開始されるようにしてください。ブラウザ、アプリ、ミニプログラムなどのクライアントから開始されたAPI呼び出しは、APIキーの漏洩につながる可能性があります。
APIキーの漏洩の疑いが検出された場合は、OpenSearch コンソールにログインして、漏洩したAPIキーを無効化してから削除してください。APIキーが無効化されると、そのAPIキーを使用してOpenSearch LLM-Based Conversational Search Edition APIを呼び出すことはできません。
API呼び出しの認証
OpenSearch LLM-Based Conversational Search Editionは、AccessKeyペアを使用してAPI呼び出しを認証します。AccessKeyペアは、Alibaba Cloudによって提供される永続的な認証情報であり、AccessKey IDとAccessKeyシークレットで構成されます。
AccessKeyペアは、Alibaba Cloud管理コンソールへのログインには使用されません。API、CLI、SDK、Terraformなどの開発ツールを使用してAlibaba Cloudサービスにアクセスするために使用されます。リクエストごとに、AccessKey IDとAccessKey Secretを使用して暗号化されたリクエストコンテンツに基づいて署名が生成されます。署名は、呼び出し元のIDとリクエストの有効性を検証するために使用されます。
API操作の呼び出し用にResource Access Management（RAM）ユーザーを作成し、RAMユーザーのAccessKeyペアを作成し、最小権限の原則に基づいてRAMユーザーに権限を付与することをお勧めします。その後、RAMユーザーはAPI操作を呼び出してサービス開発を実行できます。詳細については、「RAMユーザーを作成して権限を付与する」をご参照ください。
手順
OpenSearchコンソールにログインします。
上部のナビゲーションバーで、インスタンスが存在するリージョンを選択します。左上隅で、Opensearch LLMベースの対話型検索エディションを選択します。
インスタンス管理ページで、管理するインスタンスを見つけ、[アクション]列の管理をクリックします。左側のペインで、APIキーをクリックします。
APIキーの作成をクリックします。システムによってAPIキーが生成されます。コピーをクリックしてAPIキーを保存するか、[CSVファイルのダウンロード]をクリックしてAPIキーをCSVファイルとしてダウンロードします。
APIキーを保存した後、APIキーを保存しましたを選択し、OKをクリックします。
編集：APIキーの説明を追加します。
表示：APIキーを表示します。
無効化または有効化：APIキーを無効化または有効化します。無効化されたAPIキーは、OpenSearch LLM-Based Conversational Search Edition APIの呼び出しに使用できません。
削除：無効化されたAPIキーを削除します。
APIキーベースの承認の例
APIキーを使用してAPI呼び出しを承認します。次のサンプルは、APIキーを使用してcurlリクエストを承認する方法を示しています。URLとAPIキーを指定した後、リクエストを開始します。
curl --location 'http://***.opensearch-cn-shanghai.aliyuncs.com/v3/openapi/apps/[app_group_identity]/knowledge/entries' \
--header 'Authorization: Bearer Your API key' \
--header 'Content-Type: application/json' \
サンプルレスポンス：
{
"request_id":"4F6F9BDC-740F-4FC1-B976-74CAFCBF1333",
"status":"OK",
"total_count":2,
"latency":0.0,
"result":[
{
"entry_id":"ca0c8c1cec7c41a280c76c16f0db79f6",
"create_time":1718188424000,
"update_time":1718188424000,
"questions":[
"Where is the office address for withdrawing housing provident funds to purchase owner-occupied housing in Hangzhou?" //杭州で持家住宅を購入するための住宅積立金を引き出すための事務所の住所はどこですか？
],
"answer":"\"The office address is ****. The phone number of the office is 0571-12329-1.\"" //「事務所の住所は****です。事務所の電話番号は0571-12329-1です。」
},
{
"entry_id":"2f4c7350a7104f029f316706b61b6eb2",
"create_time":1718193627000,
"update_time":1718193627000,
"questions":[
"Can an agent apply for the cancellation of a domestic branch on behalf of others?" //代理人は、他人の代わりに国内支店のキャンセルを申請できますか？
],
"answer":"Yes, an agent can apply for the cancellation of a domestic branch on behalf of others. The agent must submit the authorization materials at the on-site window. ***** The materials must be signed by the authorizer in person." //はい、代理人は他人の代わりに国内支店のキャンセルを申請できます。代理人は、現場の窓口で承認資料を提出する必要があります。*****資料には、承認者が自ら署名する必要があります。
}
],
"errors":[]
}