Skip to main content

ListIndexFileDetails

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 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:ListIndexFileDetails

list

*All Resource

*

AucuneAucune

Syntaxe de la requête

POST /{WorkspaceId}/index/list_index_file_detail HTTP/1.1

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ètreTypeRequisDescriptionExemple
IndexIdstringNonL'identifiant de la base de connaissances, qui correspond au Data.Id renvoyé par l'opération CreateIndex.79c0alxxxx
DocumentStatusstringNonFiltre la liste des fichiers renvoyés par état d'importation de fichier. Valeurs valides :
  • INSERT_ERROR : échec de l'importation dans l'index.
  • RUNNING : création de l'index en cours.
  • DELETED : supprimé.
  • FINISH : création de l'index réussie.
  • PARSE_FAILED : échec de l'analyse.
  • DOC_PARSING : analyse en cours.
Valeur par défaut : vide, ce qui signifie qu'aucun filtrage n'est effectué par état d'importation de fichier.
FINISH
DocumentNamestringNonFiltre 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
PageNumberintegerNonLe numéro de page à interroger. Valeur minimale : 1. Valeur par défaut : 1.1
PageSizeintegerNonLe nombre de fichiers à afficher par page dans une requête paginée. Valeur maximale : 10.10
EnableNameLikestringNonIndique 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 :
  • true : effectue une correspondance floue sur la liste des fichiers renvoyés en fonction du nom de fichier.
  • false : effectue une correspondance exacte sur la liste des fichiers renvoyés en fonction du nom de fichier.
Valeur par défaut : false.Valeurs valides :
  • true : activé.
  • false : désactivé.
false

Éléments de réponse

ÉlémentTypeDescriptionExemple
objectSchéma de la réponse.
RequestIdstringL'identifiant de la requête.35A267BF-xxxx-54DB-8394-AA3B0742D833
CodestringLe code d'état de l'erreur.InvalidParameter
MessagestringLe message d'erreur.Le paramètre requis (%s) est manquant ou invalide, veuillez vérifier les paramètres de la requête
SuccessbooleanIndique si l'opération a réussi. Valeurs valides :
  • true : réussite.
  • false : échec.
true
DataobjectLe champ de données métier de l'opération.
Documentsarray<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).
objectL'objet fichier.
StatusstringThe file import status. Valid values:
  • INSERT_ERROR: File import failed.
  • RUNNING: File import in progress.
  • DELETED: File deleted.
  • FINISH: File import succeeded.
RUNNING
EnableHeadersstringIndicates whether Excel file headers support concatenation.true
MessagestringThe file import error message.check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
SizeintegerThe file size, in bytes.996764
SourceIdstringThe category ID.cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
DocumentTypestringThe file format type. Valid values: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif, EXCEL.pdf
IdstringThe file ID.doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
CodestringThe file import error status code.110002
NamestringThe file name.TranslationPlatformO&MDocument.
ChunkSizestringThe chunk length, which is the number of characters in a text chunk.600
OverlapSizestringThe chunk overlap length.100
ChunkModestringThe custom chunking mode.DashSplitter
GmtModifiedintegerThe time when the file was imported to the knowledge base, in Unix timestamp format.1744856423000
separatorstringThe sentence separator." "
MetaExtractInfostring{ "doc_summary": ["Example 1."], "health_rule": ["Example 2"] }
IndexIdstringL'identifiant de la base de connaissances.79c0alxxxx
TotalCountintegerLe nombre total de résultats renvoyés.2437
PageNumberintegerLe numéro de page renvoyé.1
PageSizeintegerLe nombre d'éléments renvoyés par page.10
StatusstringLe code d'état renvoyé par l'opération.200

Exemples

正常返回示例 JSON format
{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter\n",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "Status": "RUNNING",
        "EnableHeaders": "true",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "Size": 996764,
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx\n",
        "DocumentType": "pdf",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx\n",
        "Code": "110002",
        "Name": "TranslationPlatformO&MDocument.",
        "ChunkSize": "600",
        "OverlapSize": "100",
        "ChunkMode": "DashSplitter",
        "GmtModified": 1744856423000,
        "separator": "\" \"",
        "MetaExtractInfo": "{\n  \"doc_summary\": [\"Example 1.\"],\n  \"health_rule\": [\"Example 2\"]\n}"
      }
    ],
    "IndexId": "79c0alxxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.