Skip to main content

ListIndices

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.
Limite de fréquence : Cette opération est limitée si elle est appelée trop fréquemment. Ne dépassez pas 10 appels par seconde. En cas de limitation, 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:ListIndex

list

*All Resource

*

AucuneAucune

Syntaxe de la requête

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

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émentTypeDescriptionExemple
objectSchéma de la réponse.
RequestIdstringL'identifiant de la requête.17204B98-xxxx-4F9A-8464-2446A84821CA
DataobjectLes données renvoyées.
PageNumberintegerLe numéro de page spécifié.1
PageSizeintegerLe nombre d'entrées spécifié par page.10
TotalCountintegerLe nombre total d'entrées renvoyées.48
Indicesarray<object>La liste des bases de connaissances.
array<object>L'objet de la base de connaissances.
IdstringL'identifiant de la base de connaissances, qui correspond au Data.Id renvoyé par l'opération CreateIndex.lecxr5xxxx
NamestringLe nom de la base de connaissances.Liste de produits XXXX
DescriptionstringLa description de la base de connaissances.Les produits de cette liste sont principalement destinés aux clients étrangers
StructureTypestringLe type de base de connaissances. Valeurs valides :
  • UNSTRUCTURED : recherche de documents.
UNSTRUCTURED
ChunkSizeintegerLa taille estimée du fragment. Valeurs valides : de 1 à 2048.5
OverlapSizeintegerLa taille de chevauchement des fragments. Valeurs valides : de 0 à 1024.10
Separatorstring

Le séparateur de phrases. Si plusieurs séparateurs sont utilisés, ils sont séparés par |. Valeurs valides :

: saut de ligne
  • , : virgule chinoise
  • , : virgule anglaise
  • 。 : point chinois
  • . : point anglais
  • ! : point d'exclamation chinois
  • ! : point d'exclamation anglais
  • ; : point-virgule chinois
  • ; : point-virgule anglais
  • ? : point d'interrogation chinois
  • ? : point d'interrogation anglais
\n
EmbeddingModelNamestringLe nom du modèle d'embedding. Valeurs valides :
  • text-embedding-v2 : modèle text-embedding-v2.
text-embedding-v2
RerankModelNamestringLe nom du modèle de reclassement. Valeurs valides :
  • gte-rerank-hybrid : reclassement officiel.
  • gte-rerank : reclassement gte-rerank.
gte-rerank-hybrid
RerankMinScorestringLe seuil de similarité. Valeurs valides : de 0,01 à 1,00.0.01
SourceTypestringLe 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_CATEGORY : type de catégorie.
  • DATA_CENTER_FILE : type de fichier.
Pour les bases de connaissances de requête de données/questions-réponses sur images, valeurs valides :
  • DATA_CENTER_STRUCTURED_TABLE : type de table de données.
DATA_CENTER_FILE
DocumentIdsarrayLa liste des identifiants de fichiers.
stringL'identifiant du fichier.file_8c67b438043848199ffaa903d29addd4_xxxxxxxx
SinkTypestringLe type de stockage vectoriel de la base de connaissances. Valeurs valides :
  • ES : base de données vectorielle intégrée.
  • BUILT_IN : base de données vectorielle intégrée.
  • ADB : base de données AnalyticDB for PostgreSQL.
BUILT_IN
SinkInstanceIdstringL'identifiant de l'instance de stockage vectoriel pour la base de connaissances.gp-bp1gq62t1788yxxxx
SinkRegionstringLa région de l'instance de stockage vectoriel pour la base de connaissances.cn-hangzhou
ConfgModelstringLe mode de configuration utilisé par cette base de connaissances. Valeurs valides :
  • recommend : configuration recommandée.
  • user-defined : configuration personnalisée.
recommend
EnableRewritebooleanIndique si la réécriture de conversation multi-tours est activée pour cette base de connaissances. Valeurs valides :
  • true : Activé.
  • false : Désactivé.
false
StructuredIndexConfigarray<object>
object
Namestringname
TypestringValeurs valides :
  • datetime : datetime
  • string : string
  • double : double
  • image_url : image_url
  • long : long
string
IsSearchbooleanValeurs valides :
  • true : true
  • false : false
true
IsRecallbooleanValeurs valides :
  • true : true
  • false : false
true
PipelineCommercialTypestringLe type de spécification de la base de connaissances. Valeurs valides :
  • standard : édition Standard.
  • enterprise : édition Enterprise.
standard
PipelineCommercialCuintegerLe 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
PipelineStorageUsagenumberL'utilisation du stockage de la base de connaissances. Unité : GB.0.03
CodestringLe code d'état de l'erreur.Index.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éussie.
  • false : Échouée.
true
StatusstringLe code d'état renvoyé par l'opération.200

Exemples

正常返回示例 JSON format
{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 48,
    "Indices": [
      {
        "Id": "lecxr5xxxx",
        "Name": "Liste de produits XXXX",
        "Description": "Les produits de cette liste sont principalement destinés aux clients étrangers",
        "StructureType": "UNSTRUCTURED",
        "ChunkSize": 5,
        "OverlapSize": 10,
        "Separator": "\\n",
        "EmbeddingModelName": "text-embedding-v2",
        "RerankModelName": "gte-rerank-hybrid",
        "RerankMinScore": "0.01",
        "SourceType": "DATA_CENTER_FILE",
        "DocumentIds": [
          "file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
        ],
        "SinkType": "BUILT_IN",
        "SinkInstanceId": "gp-bp1gq62t1788yxxxx",
        "SinkRegion": "cn-hangzhou",
        "ConfgModel": "recommend",
        "EnableRewrite": false,
        "StructuredIndexConfig": [
          {
            "Name": "name",
            "Type": "string",
            "IsSearch": true,
            "IsRecall": true
          }
        ],
        "PipelineCommercialType": "standard",
        "PipelineCommercialCu": 1,
        "PipelineStorageUsage": 0.03
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "Paramètre requis (%s) manquant ou invalide, veuillez vérifier les paramètres de la requête",
  "Success": true,
  "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.