Obtient la liste des bases de connaissances dans un espace de travail spécifié.
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:ListIndex), 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. - 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:ListIndex | 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 la base de connaissances 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-3shx2gu255oq6xxxx |
Paramètres de requête
Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
| IndexName | string | Non | Le nom de la base de connaissances. Vous pouvez rechercher une base de connaissances par son nom. Le nom doit comporter entre 1 et 20 caractères et peut contenir des caractères de la catégorie des lettres Unicode (y compris les lettres anglaises, les caractères chinois et les chiffres). Le nom peut également contenir des deux-points (:), des traits de soulignement (_), des points (.) ou des traits d'union (-). Valeur par défaut : vide, ce qui interroge toutes les bases de connaissances de l'espace de travail spécifié. | idx_status_score |
| PageNumber | string | Non | Le numéro de page à interroger. Valeur minimale : 1. Valeur par défaut : 1. | 1 |
| PageSize | string | Non | Le nombre de bases de connaissances à 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. | ||
| RequestId | string | L'identifiant de la requête. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Data | object | Les données renvoyées. | |
| PageNumber | integer | Le numéro de page spécifié. | 1 |
| PageSize | integer | Le nombre d'entrées spécifié par page. | 10 |
| TotalCount | integer | Le nombre total d'entrées renvoyées. | 48 |
| Indices | array<object> | La liste des bases de connaissances. | |
| array<object> | L'objet de la base de connaissances. | ||
| Id | string | L'identifiant de la base de connaissances, qui correspond au Data.Id renvoyé par l'opération CreateIndex. | lecxr5xxxx |
| Name | string | Le nom de la base de connaissances. | Liste de produits XXXX |
| Description | string | La description de la base de connaissances. | Les produits de cette liste sont principalement destinés aux clients étrangers |
| StructureType | string | Le type de base de connaissances. Valeurs valides :
| UNSTRUCTURED |
| ChunkSize | integer | La taille estimée du fragment. Valeurs valides : de 1 à 2048. | 5 |
| OverlapSize | integer | La taille de chevauchement des fragments. Valeurs valides : de 0 à 1024. | 10 |
| Separator | string | Le séparateur de phrases. Si plusieurs séparateurs sont utilisés, ils sont séparés par |. Valeurs valides :: saut de ligne
| \n |
| EmbeddingModelName | string | Le nom du modèle d'embedding. Valeurs valides :
| text-embedding-v2 |
| RerankModelName | string | Le nom du modèle de reclassement. Valeurs valides :
| gte-rerank-hybrid |
| RerankMinScore | string | Le seuil de similarité. Valeurs valides : de 0,01 à 1,00. | 0.01 |
| SourceType | string | Le type de données dans Alibaba Cloud Model Studio Données d'application.Pour les bases de connaissances de recherche de documents, valeurs valides :
| DATA_CENTER_FILE |
| DocumentIds | array | La liste des identifiants de fichiers. | |
| string | L'identifiant du fichier. | file_8c67b438043848199ffaa903d29addd4_xxxxxxxx | |
| SinkType | string | Le type de stockage vectoriel de la base de connaissances. Valeurs valides :
| BUILT_IN |
| SinkInstanceId | string | L'identifiant de l'instance de stockage vectoriel pour la base de connaissances. | gp-bp1gq62t1788yxxxx |
| SinkRegion | string | La région de l'instance de stockage vectoriel pour la base de connaissances. | cn-hangzhou |
| ConfgModel | string | Le mode de configuration utilisé par cette base de connaissances. Valeurs valides :
| recommend |
| EnableRewrite | boolean | Indique si la réécriture de conversation multi-tours est activée pour cette base de connaissances. Valeurs valides :
| false |
| StructuredIndexConfig | array<object> | ||
| object | |||
| Name | string | name | |
| Type | string | Valeurs valides :
| string |
| IsSearch | boolean | Valeurs valides :
| true |
| IsRecall | boolean | Valeurs valides :
| true |
| PipelineCommercialType | string | Le type de spécification de la base de connaissances. Valeurs valides :
| standard |
| PipelineCommercialCu | integer | Le nombre de RCU de la base de connaissances. Ce paramètre n'est valide que pour les bases de connaissances de l'édition Enterprise. | 1 |
| PipelineStorageUsage | number | L'utilisation du stockage de la base de connaissances. Unité : GB. | 0.03 |
| Code | string | Le code d'état de l'erreur. | Index.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 |
| Status | string | Le code d'état renvoyé par l'opération. | 200 |
Exemples
正常返回示例
JSON format