Lorsque vous appelez le service OpenSearch LLM-Based Conversational Search Edition via une API ou un SDK, vous devez authentifier ou autoriser l'identité de l'appelant. Cette rubrique décrit les méthodes d'authentification et d'autorisation, ainsi que la procédure de gestion des clés API.
Authentification des appels API
Authentifiez les appels API à l'aide d'une clé API : il s'agit d'une méthode d'authentification fournie par LLM-Based Conversational Search Edition. Lorsque vous utilisez cette méthode pour appeler une API, vous devez fournir une clé d'accès, c'est-à-dire une clé API. Vous pouvez créer et activer jusqu'à 10 clés API par instance.
Pour éviter la divulgation des clés API :
Ne divulgez votre clé API sous aucune forme afin d'éviter les risques de sécurité ou les pertes financières liés à une utilisation non autorisée.
Initiez les appels API uniquement côté serveur. Tout appel API initié côté client, tel qu'un navigateur, une application ou un mini-programme, risque d'entraîner la divulgation de la clé API.
Si vous soupçonnez qu'une clé API a été divulguée, connectez-vous à OpenSearch LLM-Based Conversational Search Edition pour désactiver puis supprimer la clé API. Une fois désactivée, la clé API ne peut plus être utilisée pour effectuer des appels API.
Autorisation des appels API
Autorisez les appels API à l'aide d'une paire AccessKey (AK) : il s'agit d'un identifiant d'accès permanent fourni par Alibaba Cloud, composé d'un AccessKey ID et d'un AccessKey secret.
Une paire AccessKey n'est pas utilisée pour se connecter à la console. Elle sert plutôt à accéder à Alibaba Cloud via des outils de développement (tels que les API, la CLI, les SDK et Terraform). Les requêtes contiennent une signature générée en chiffrant le contenu de la requête avec l'AccessKey ID et l'AccessKey secret, ce qui permet de vérifier votre identité et la validité de la requête.
Nous vous recommandons vivement de créer un utilisateur RAM dédié à l'accès API, de générer la paire AccessKey correspondante, d'accorder des autorisations selon le principe du moindre privilège, puis d'appeler le service de l'espace de travail de développement via l'API. Pour plus d'informations, consultez Créer des utilisateurs RAM et accorder des autorisations.
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, puis choisissez API keys dans le volet de navigation de gauche.
Cliquez sur Create an API KEY. Le système génère une clé API. Cliquez sur Copy pour enregistrer la clé API, ou téléchargez un fichier CSV pour sauvegarder les informations de la clé API.
-
Après avoir enregistré la clé API en toute sécurité, cliquez sur I have saved my API KEY., puis cliquez sur OK pour fermer la boîte de dialogue.
Modifier : ajoutez une description pour la clé API.
Afficher : consultez la clé API.
Désactiver/Activer : lorsqu'elle est désactivée, la clé API ne peut pas être utilisée pour effectuer des appels API. Lorsqu'elle est activée, la clé API peut être utilisée pour effectuer des appels API.
Supprimer : vous pouvez supprimer une clé API lorsqu'elle est désactivée.
Exemple d'authentification par clé API
Vous pouvez également authentifier les appels à l'aide d'une clé API. Voici un exemple de requête curl utilisant l'authentification par clé API pour récupérer une liste de termes. Après avoir configuré l'URL et la clé API, exécutez un test.
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 office address for withdrawing housing provident fund to buy owner-occupied housing in Hangzhou"
],
"answer":"\"Hello, the office address is ****, contact phone: 0571-12329-1\""
},
{
"entry_id":"2f4c7350a7104f029f316706b61b6eb2",
"create_time":1718193627000,
"update_time":1718193627000,
"questions":[
"Can someone help handle the deregistration application for a domestic-funded branch on my behalf?"
],
"answer":"Yes, it can be handled on your behalf. When submitting materials at the on-site window, the authorization ***** and the authorized person should sign personally."
}
],
"errors":[]
}