Soumet une tâche CreateIndex spécifiée pour finaliser la création de la base de connaissances.
Description de l'opération
- Les utilisateurs Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Model Studio (nécessite
AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:SubmitIndexJob), et rejoindre un espace de travail avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Utilisez la dernière version du SDK Model Studio pour appeler cette opération. - Avant d'appeler cette opération, vous devez appeler l'opération CreateIndex et obtenir l'
IndexIdcorrespondant. - Après l'appel de cette opération, le nœud nécessite du temps pour s'exécuter et peut prendre plusieurs heures pendant les périodes de pointe. Ne soumettez pas de requêtes en double avant la fin de l'exécution du nœud. Pour interroger l'état d'exécution du nœud, appelez l'opération GetIndexJobStatus.
- Une fois la base de connaissances créée, vous pouvez l'associer à une application d'agent dans le même espace de travail via Gestion des applications (ou transmettre l'
IndexIDviarag_optionsdans les Appels d'application) pour enrichir votre application Model Studio avec des connaissances privées et des informations à jour. Vous pouvez également choisir de ne pas utiliser d'application Model Studio et d'interroger directement la base de connaissances en appelant l'opération Retrieve. - Cette opération ne prend pas en charge l'idempotence.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Autorisation RAM
Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :
-
Action : les actions peuvent être utilisées dans l'élément
Actiondes instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération. - API : l'API que vous pouvez appeler pour exécuter l'action.
- Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
-
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
Resourcede la politique. - Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément
Resourcede la politique.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément
- Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
- Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.
Action | Niveau d'accès | Type de ressource | Clé de condition | Action dépendante |
|---|---|---|---|---|
sfm:SubmitIndexJob | create | *All Resource
| Aucune | Aucune |
Syntaxe de la requête
Paramètres de chemin
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| WorkspaceId | string | Oui | L'identifiant de l'espace de travail auquel appartient la base de connaissances. Pour plus d'informations sur la façon d'obtenir l'identifiant de l'espace de travail, consultez Comment utiliser un espace de travail. | llm-3shx2gu255oqxxxx |
Paramètres de requête
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| IndexId | string | Oui | L'identifiant de la base de connaissances, qui correspond au | 79c0alxxxx |
Éléments de réponse
| Élément | Type | Description | Exemple |
|---|---|---|---|
| object | Schéma de la réponse. | ||
| Code | string | Le code d'erreur. | Index.InvalidParameter |
| Data | object | Les données métier renvoyées par l'opération. | |
| Id | string | L'identifiant de la tâche, qui correspond au JobId requis lors de l'appel de l'opération GetIndexJobStatus. | eFDr2fGRzP9gdDZWAdo3xxxx |
| IndexId | string | L'identifiant de la base de connaissances. | 79c0alxxxx |
| Message | string | Le message d'erreur. | Paramètre requis (%s) manquant ou invalide, veuillez vérifier les paramètres de la requête |
| RequestId | string | L'identifiant de la requête. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | Le code d'état renvoyé par l'opération. | 200 |
| Success | boolean | Indique si l'opération a réussi. Valeurs valides :
| true |
Exemples
正常返回示例
JSON format
Codes d'erreur
Code de statut HTTP | Code d'erreur | Message d'erreur | Description |
|---|---|---|---|
| 400 | RagIndex.IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | This request uses the same client token as the previous but different request. Do not reuse client tokens with different requests unless the request is the same. |