Skip to main content

ListIndexDocuments

Obtient les fichiers et leurs informations de synthèse à 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 Model Studio (nécessite AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ListIndexFiles) 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, 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.
Limitation du débit : Cette opération est limitée si elle est appelée trop fréquemment. Ne dépassez pas 15 appels par seconde. Si vous êtes limité, réessayez plus tard.

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

list

*All Resource

*

AucuneAucune

Syntaxe de la requête

GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

Paramètres de chemin

Paramètre

Type

Requis

Description

Exemple

WorkspaceId

string

Oui

L'identifiant de l'espace de travail de 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. La version actuelle de l'API (2023-12-29) ne fournit pas d'opération permettant de lister les espaces de travail. Obtenez l'identifiant de l'espace de travail dans la console Model Studio avant d'appeler cette opération.

llm-3z7uw7fwz0vexxxx

Paramètres de requête

ParamètreTypeRequisDescriptionExemple
IndexIdstringOuiL'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 : construction de l'index en cours.
  • DELETED : supprimé.
  • FINISH : construction 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 par état d'importation de fichier n'est appliqué.
FINISH
DocumentNamestringNonFiltre la liste des fichiers renvoyés par nom de fichier (sans l'extension de fichier). Valeur par défaut : vide, ce qui signifie qu'aucun filtrage par nom de fichier n'est appliqué.product-overview
EnableNameLikestringNonIndique si la correspondance approximative pour les noms de fichiers doit être activée. Ce paramètre est utilisé conjointement avec le paramètre DocumentName. Valeurs valides :
  • true : effectue une correspondance approximative 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
PageNumberintegerNonLe numéro de page. Valeur minimale : 1. Valeur par défaut : 1.1
PageSizeintegerNonLe nombre 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émentTypeDescriptionExemple
objectSchéma de la réponse.
RequestIdstringL'identifiant de la requête.35A267BF-xxxx-54DB-8394-AA3B0742D833
CodestringLe code d'état d'erreur.InvalidParameter
MessagestringLe message d'erreur.Paramètre requis (%s) 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 renvoyé par l'opération.
Documentsarray<object>La liste des fichiers dans la base de connaissances, triée par heure d'importation du document par ordre décroissant (cohérent avec la console).
objectL'objet fichier.
SourceIdstringFor document search knowledge bases, this parameter specifies the category ID, which is the CategoryId returned by the AddCategory operation. You can also obtain it by clicking the ID icon next to the category name on the Files tab of Application Data.For data query or image Q&A knowledge bases, this parameter specifies the data table ID. You can obtain it by clicking the ID icon next to the data table name on the Tables tab of Application Data.cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
IdstringThe file ID.doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
NamestringThe file name.product-overview
SizeintegerThe file size, in bytes.996765
DocumentTypestringThe file format type. Valid values: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif, and EXCEL.pdf
StatusstringThe file import status. Valid values:
  • INSERT_ERROR: File import failed.
  • RUNNING: File import in progress.
  • DELETED: File deleted.
  • FINISH: File import succeeded.
Valeurs valides :
  • INSERT_ERROR : file import failed.
  • RUNNING : file import in progress.
  • DELETED : file deleted.
  • FINISH : file import succeeded.
RUNNING
CodestringThe error status code for file import.110002
MessagestringThe error message for file import.check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
GmtModifiedintegerThe time when the file was imported to the knowledge base, in UNIX timestamp format.1744856423000
IndexIdstringL'identifiant de la base de connaissances.pno97txxxx
TotalCountintegerLe nombre total de résultats renvoyés.2437
PageNumberintegerLe numéro de page renvoyé.1
PageSizeintegerLe nombre d'entrées renvoyées par page.10
StatusstringLe code d'état renvoyé par l'opération.200

Exemples

正常返回示例 JSON format
{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Name": "product-overview",
        "Size": 996765,
        "DocumentType": "pdf",
        "Status": "RUNNING",
        "Code": "110002",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "GmtModified": 1744856423000
      }
    ],
    "IndexId": "pno97txxxx",
    "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.