Obtient les fichiers et leurs détails à partir d'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 (nécessite AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ListIndexFiles), avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Appelez cette opération via la dernière version du SDK Alibaba Cloud Model Studio.
- Avant d'appeler cette opération, assurez-vous que votre base de connaissances a été créée et n'a pas été supprimée (c'est-à-dire que l'identifiant de la base de connaissances IndexId est valide).
- Cette opération est idempotente.
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:ListIndexFileDetails | list | *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-3z7uw7fwz0vexxxx |
Paramètres de requête
| Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| IndexId | string | Non | L'identifiant de la base de connaissances, qui correspond au Data.Id renvoyé par l'opération CreateIndex. | 79c0alxxxx |
| DocumentStatus | string | Non | Filtre la liste des fichiers renvoyés par état d'importation de fichier. Valeurs valides :
| FINISH |
| DocumentName | string | Non | Filtre la liste des détails des fichiers renvoyés par nom de fichier. Valeur par défaut : vide, ce qui signifie qu'aucun filtrage n'est effectué par nom de fichier. | TranslationPlatformO&MDocument |
| PageNumber | integer | Non | Le numéro de page à interroger. Valeur minimale : 1. Valeur par défaut : 1. | 1 |
| PageSize | integer | Non | Le nombre de fichiers à afficher par page dans une requête paginée. Valeur maximale : 10. | 10 |
| EnableNameLike | string | Non | Indique si la correspondance floue doit être activée pour les noms de fichiers. Ce paramètre est utilisé conjointement avec le paramètre DocumentName. Valeurs valides :
| false |
Éléments de réponse
| Élément | Type | Description | Exemple |
|---|---|---|---|
| object | Schéma de la réponse. | ||
| RequestId | string | L'identifiant de la requête. | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | Le code d'état de l'erreur. | InvalidParameter |
| Message | string | Le message d'erreur. | Le paramètre requis (%s) est manquant ou invalide, veuillez vérifier les paramètres de la requête |
| Success | boolean | Indique si l'opération a réussi. Valeurs valides :
| true |
| Data | object | Le champ de données métier de l'opération. | |
| Documents | array<object> | La liste des fichiers dans la base de connaissances, triée par ordre décroissant d'heure d'importation des fichiers (cohérent avec la console). | |
| object | L'objet fichier. | ||
| Status | string | The file import status. Valid values:
| RUNNING |
| EnableHeaders | string | Indicates whether Excel file headers support concatenation. | true |
| Message | string | The file import error message. | check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| Size | integer | The file size, in bytes. | 996764 |
| SourceId | string | The category ID. | cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx |
| DocumentType | string | The file format type. Valid values: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif, EXCEL. | |
| Id | string | The file ID. | doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Code | string | The file import error status code. | 110002 |
| Name | string | The file name. | TranslationPlatformO&MDocument. |
| ChunkSize | string | The chunk length, which is the number of characters in a text chunk. | 600 |
| OverlapSize | string | The chunk overlap length. | 100 |
| ChunkMode | string | The custom chunking mode. | DashSplitter |
| GmtModified | integer | The time when the file was imported to the knowledge base, in Unix timestamp format. | 1744856423000 |
| separator | string | The sentence separator. | " " |
| MetaExtractInfo | string | { "doc_summary": ["Example 1."], "health_rule": ["Example 2"] } | |
| IndexId | string | L'identifiant de la base de connaissances. | 79c0alxxxx |
| TotalCount | integer | Le nombre total de résultats renvoyés. | 2437 |
| PageNumber | integer | Le numéro de page renvoyé. | 1 |
| PageSize | integer | Le nombre d'éléments renvoyés par page. | 10 |
| Status | string | Le code d'état renvoyé par l'opération. | 200 |
Exemples
正常返回示例
JSON format