GetIndexJobStatus - Alibaba Cloud Model Studio - Centre de documentation Alibaba Cloud

Consulte l'état actuel d'une tâche de création de base de connaissances ou d'une tâche d'ajout de documents à une base de connaissances spécifiée.

Description de l'opération

Les utilisateurs Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Alibaba Cloud Model Studio (AliyunBailianDataFullAccess ou AliyunBailianDataReadOnlyAccess, qui incluent toutes deux l'autorisation sfm:GetIndexJobStatus), 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 Alibaba Cloud Model Studio pour appeler cette opération.
Vous devez avoir une tâche de base de connaissances en cours. Vous pouvez créer une tâche de création de base de connaissances en appelant l'opération SubmitIndexJob, ou créer une tâche d'ajout de documents à une base de connaissances en appelant l'opération SubmitIndexAddDocumentsJob. Obtenez le JobId correspondant.
Appelez cette opération à des intervalles de 5 secondes ou plus.
Cette opération prend 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 Action des 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 Resource de 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 Resource de la politique.
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:GetIndexJobStatus	get	All Resource ``	Aucune	Aucune

Action

Niveau d'accès

Type de ressource

Clé de condition

Action dépendante

sfm:GetIndexJobStatus

get

*All Resource

*

Aucune

Syntaxe de la requête

GET /{WorkspaceId}/index/job/status HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
WorkspaceId	string	Oui	L'identifiant de l'espace de travail. Assurez-vous que la base de connaissances sur laquelle vous souhaitez opérer se trouve dans cet espace de travail. 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-3z7uw7fwz0vexxxx

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
JobId	string	Oui	L'identifiant de la tâche de la base de connaissances, qui correspond au `Data.Id` renvoyé par l'opération SubmitIndexJob ou SubmitIndexAddDocumentsJob.	20230718xxxx-146c93bf
IndexId	string	Oui	L'identifiant de la base de connaissances, qui correspond au `Data.Id` renvoyé par l'opération CreateIndex.	79c0alxxxx
PageNumber	integer	Non	Les opérations SubmitIndexJob et SubmitIndexAddDocumentsJob prennent toutes deux en charge l'importation de fichiers par lot. Cette opération renvoie l'état global de la tâche de la base de connaissances (`Status`) et l'état d'importation de chaque fichier (`Document.Status`). S'il y a de nombreux fichiers, utilisez le paramètre `PageNumber` pour une requête paginée. Valeur minimale : 1. Valeur par défaut : 1.	1
pageSize	integer	Non	Le nombre de tâches d'importation de fichiers à afficher par page dans une requête paginée. Aucune limite maximale. Valeur par défaut : 10.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Code	string	Le code d'état d'erreur.	Index.Forbidden
Data	object	Le champ de données renvoyé par l'opération.
Documents	array<object>	La liste des fichiers importés dans cette tâche.
	object	L'objet fichier.
Code	string	The error status code.	Index.Document.ChunkError
DocId	string	The file ID.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
DocName	string	The file name.	XXX产品介绍
Message	string	The error message.	document parse error
Status	string	The file import status. Valid values: INSERT_ERROR: Failed to import into the index. RUNNING: Index building in progress. DELETED: Deleted. FINISH: Index building succeeded. PARSE_FAILED: Parsing failed. DOC_PARSING: Parsing in progress.	RUNNING
GmtModified	integer
JobId	string	L'identifiant de la tâche.	66122af12a4e45ddae6bd6c84555xxxx
Status	string	L'état actuel de la tâche de la base de connaissances. Valeurs valides : COMPLETED : Exécution réussie. FAILED : Échec de l'exécution. RUNNING : Exécution en cours. PENDING : En attente d'exécution. Valeurs valides : COMPLETED : Exécution réussie. FAILED : Échec de l'exécution. RUNNING : Exécution en cours. PENDING : En attente d'exécution.	PENDING
Message	string	Le message d'erreur.	User not authorized to operate on the specified resource
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 : Réussite. false : Échec.	true

Exemples

正常返回示例

JSON format

{
  "Code": "Index.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.