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

Consulte les informations de base d'un fichier dans les données d'application, notamment son nom, son type et son état.

Description de l'opération

Un utilisateur Resource Access Management (RAM) doit d'abord obtenir les autorisations d'API pour Model Studio (AliyunBailianDataFullAccess ou AliyunBailianDataReadOnlyAccess, qui incluent toutes deux l'autorisation sfm:DescribeFile), et rejoindre un espace de travail avant d'appeler cette opération. Un compte Alibaba Cloud peut appeler cette opération directement sans autorisation. Utilisez la dernière version du SDK Model Studio pour appeler cette opération.
Cette opération est idempotente.

Limitation du débit : Cette opération est limitée si elle est appelée trop fréquemment. Ne dépassez pas 10 appels par seconde. Si votre débit est limité, réessayez ultérieurement.

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:DescribeFile	none	All Resource ``	Aucune	Aucune

Action

Niveau d'accès

Type de ressource

Clé de condition

Action dépendante

sfm:DescribeFile

none

*All Resource

*

Aucune

Syntaxe de la requête

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
WorkspaceId	string	Oui	L'identifiant de l'espace de travail auquel le fichier appartient. 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
FileId	string	Oui	L'identifiant du fichier, qui correspond au FileId renvoyé par l'opération AddFile. Vous pouvez également obtenir l'identifiant du fichier en cliquant sur l'icône d'identifiant à côté du nom du fichier dans l'onglet Données d'application - Fichiers.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Code	string	Le code d'état de l'erreur.	Success
Data	object	Le champ de données renvoyé par l'opération.
CategoryId	string	L'identifiant de la catégorie à laquelle le fichier appartient.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CreateTime	string	L'horodatage de l'ajout du fichier à Model Studio. Format : yyyy-MM-dd HH:mm:ss. Fuseau horaire : UTC+8.	2024-09-09 12:45:43
FileId	string	L'identifiant du fichier.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
FileName	string	Le nom du fichier.	XXX Présentation du produit.pdf
FileType	string	Le type de fichier (extension). Valeurs possibles : pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp et gif.	pdf
Parser	string	Le type d'analyseur utilisé pour analyser le fichier. Valeurs possibles : DASHSCOPE_DOCMIND : l'analyseur de documents par défaut.	DASHSCOPE_DOCMIND
SizeInBytes	integer	La taille du fichier, en octets.	1234
Status	string	Pour les fichiers utilisés dans les bases de connaissances non structurées (type : UNSTRUCTURED), valeurs possibles : INIT : en attente d'analyse. IN_PARSE_QUEUE : en file d'attente pour l'analyse. PARSING : en cours d'analyse. PARSE_SUCCESS : analyse terminée. RemarqueLe document ne peut être importé dans une base de connaissances qu'après que l'état est passé à PARSE_SUCCESS. PARSE_FAILED : échec de l'analyse.	PARSE_SUCCESS
Tags	array	La liste des balises associées au fichier. Un fichier peut être associé à plusieurs balises.
	string	La balise du fichier.	Présentation du produit
ParseResultDownloadUrl	string
ParseErrorMessage	string	La raison de l'échec de l'analyse.	Message d'erreur
Message	string	Le message d'erreur.	Limitation du débit des requêtes déclenchée
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'appel a réussi. Valeurs valides : true : réussi. false : échec.	true

Exemples

正常返回示例

JSON format

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX产品介绍.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "产品介绍"
    ],
    "ParseResultDownloadUrl": "",
    "ParseErrorMessage": "Error Message"
  },
  "Message": "Requests throttling triggered.",
  "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.