Les appels d'API et de SDK vers l'édition Conversationnelle basée sur les LLM d'OpenSearch doivent être authentifiés ou autorisés. Cette rubrique décrit les méthodes d'authentification et d'autorisation, et explique comment gérer les clés API.
Authentification des appels d'API
Utilisez une clé API pour authentifier vos appels d'API. Incluez une clé API dans votre requête. Vous pouvez créer et activer jusqu'à 10 clés API par instance.
Pour éviter la divulgation de votre clé API :
Ne divulgez pas publiquement votre clé API. Une utilisation non autorisée peut entraîner des risques de sécurité ou des pertes financières.
Effectuez les appels d'API uniquement côté serveur. Les appels côté client (navigateurs, applications ou mini-programmes) risquent d'exposer votre clé API.
Si vous soupçonnez qu'une clé API a été compromise, connectez-vous à la console OpenSearch pour désactiver la clé, puis supprimez-la. Une clé API désactivée ne peut plus servir aux appels d'API.
Autorisation des appels d'API
Utilisez un AccessKey pour autoriser les appels d'API. Un AccessKey est un identifiant permanent fourni par Alibaba Cloud. Il se compose d'une paire : un ID AccessKey et un secret AccessKey.
Les AccessKeys ne servent pas à se connecter à la console. Ils permettent d'accéder à Alibaba Cloud via des outils de développement tels que les API, les CLI, les SDK et Terraform. Ces outils signent les requêtes à l'aide de l'ID AccessKey et du secret AccessKey afin de vérifier l'identité de l'expéditeur et l'intégrité de la requête.
Nous vous recommandons vivement de créer un utilisateur RAM dédié pour l'accès aux API, de générer un AccessKey correspondant et d'accorder uniquement les permissions minimales requises. Pour plus d'informations, consultez Créer un AccessKey et Créer un utilisateur RAM et accorder des permissions.
Procédure
Connectez-vous à la console OpenSearch.
Sélectionnez la région cible et basculez vers OpenSearch LLM-Based Conversational Search Edition.
Dans la liste des instances, cliquez sur Manage à droite de l'instance cible. Dans le volet de navigation de gauche, cliquez sur API keys.
Cliquez sur Create API Key. Cela génère une clé API. Cliquez sur Copy pour sauvegarder la clé API, ou téléchargez le fichier CSV pour enregistrer les informations de la clé API.
-
Après avoir enregistré la clé API en toute sécurité, sélectionnez I have saved my API KEY. et cliquez sur OK pour fermer la boîte de dialogue.
Edit : Ajoutez une description pour la clé API.
View : Consultez la clé API.
Disable/Enable : Active ou désactive la clé API. Une clé désactivée ne peut pas servir aux appels d'API.
Delete : Vous ne pouvez supprimer qu'une clé API désactivée.
Exemple : authentification par clé API
L'exemple suivant montre une requête curl qui utilise une clé API pour récupérer une liste d'entrées. Pour exécuter l'exemple, mettez à jour l'URL et remplacez l'espace réservé par votre clé 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'Exemple de réponse :
{
"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 service office address for withdrawing the housing provident fund when buying an owner-occupied home in Hangzhou?"
],
"answer":"\"Hello, the service address is ****. Contact number: 0571-12329-1\""
},
{
"entry_id":"2f4c7350a7104f029f316706b61b6eb2",
"create_time":1718193627000,
"update_time":1718193627000,
"questions":[
"Can someone help me apply for deregistration of a domestic-funded branch company on my behalf?"
],
"answer":"Yes. You can authorize someone to apply on your behalf. Submit the required materials at the on-site counter. The authorizer must sign in person."
}
],
"errors":[]
}