Skip to main content

CreateIndex

Crée une base de connaissances, qu'il s'agisse d'une base de connaissances non structurée basée sur des documents ou de l'audio/vidéo, ou d'une base de connaissances structurée pour les requêtes de données ou les questions-réponses basées sur des images.

Description de l'opération

  • Exigences en matière d'autorisations :

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

create

*All Resource

*

AucuneAucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre

Type

Requis

Description

Exemple

WorkspaceId

string

Oui

L'identifiant de l'espace de travail, qui spécifie l'espace de travail dans lequel créer la base de connaissances. Pour plus d'informations, consultez Comment utiliser les espaces de travail.

llm-3z7uw7fwz0vexxxx

Paramètres de requête

ParamètreTypeRequisDescriptionExemple
NamestringOuiLe nom de la base de connaissances. Le nom doit comporter entre 1 et 20 caractères et peut contenir des caractères chinois, des lettres, des chiffres, des traits de soulignement (_), des traits d'union (-), des points (.) et des deux-points (:).Bibliothèque de documents d'aide de l'entreprise
StructureTypestringOuiLe type de base de connaissances.Valeurs valides :
  • unstructured : Une base de connaissances de recherche de documents ou audio/vidéo. Le scénario par défaut pour le type de recherche de documents est les questions-réponses de base sur les documents.
Le type de base de connaissances ne peut pas être modifié après sa création.
Valeurs valides :
  • unstructured : non structuré.
unstructured
EmbeddingModelNamestringNon
  • modèle d'embedding utilisé par la base de connaissances. Le modèle d'embedding transforme le prompt d'entrée original et le texte de connaissances en vecteurs numériques pour la comparaison de similarité. Le modèle text-embedding-v2 par défaut (non modifiable) prend en charge le chinois, l'anglais et de nombreuses autres langues, et effectue une normalisation des résultats vectoriels. Pour plus d'informations, consultez Vectorisation. Valeurs valides :
  • text-embedding-v2
Valeur par défaut : vide, auquel cas le modèle text-embedding-v2 est utilisé.
text-embedding-v4
RerankModelNamestringNonLe modèle de reclassement utilisé par la base de connaissances. Le modèle de reclassement est un système de notation externe qui calcule le score de similarité entre la requête de l'utilisateur et chaque fragment de texte de la base de connaissances, les trie par ordre décroissant et renvoie les K premiers fragments de texte avec les scores les plus élevés. Valeurs valides :
  • gte-rerank-hybrid : reclassement officiel.
  • gte-rerank : reclassement gte-rerank.
Valeur par défaut : vide, ce qui utilise gte-rerank-hybrid.
Si vous avez uniquement besoin d'un reclassement sémantique, utilisez gte-rerank. Si vous avez besoin à la fois de fonctionnalités de reclassement sémantique et de correspondance de texte pour garantir la pertinence, utilisez gte-rerank-hybrid.
Valeurs valides :
  • gte-rerank-hybrid : reclassement officiel.
  • gte-rerank : reclassement gte-rerank.
gte-rerank-hybrid
RerankMinScorenumberNonLe seuil de similarité. Seuls les fragments de texte dont les scores de similarité dépassent cette valeur sont rappelés. Ce paramètre filtre les fragments de texte renvoyés par le modèle de reclassement. Plage de valeurs : [0.01-1.00].0.20
ChunkSizeintegerNonLa taille du fragment, qui spécifie le nombre maximal de caractères par fragment de texte. Lorsque cette longueur est dépassée, le texte risque d'être tronqué.Plage de valeurs : [1-6000]. Si non spécifié, la valeur par défaut est 500.
Si ChunkSize est défini sur une valeur inférieure à 100, vous devez également définir OverlapSize. Vous pouvez également laisser ces deux paramètres non spécifiés, et le système utilisera les valeurs par défaut.
128
OverlapSizeintegerNonLa taille de chevauchement des fragments, qui indique le nombre de caractères se chevauchant entre le fragment de texte actuel et le fragment de texte précédent. Plage de valeurs : [0-1024].Si ce paramètre n'est pas spécifié, la valeur par défaut est 100.
OverlapSize doit être inférieur à ChunkSize. Dans le cas contraire, des exceptions de fragmentation se produisent.
16
SeparatorstringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
(?<=。)
SourceTypestringNon
Ce paramètre est requis dans la version la plus récente du SDK. Dans le cas contraire, l'appel de l'opération SubmitIndexJob renvoie une erreur : Paramètre requis (data_sources) manquant ou non valide.
Le type de source de données. Valeurs valides :
  • DATA_CENTER_CATEGORY : type de catégorie. Importe tous les fichiers des catégories spécifiées dans Données d'application. Plusieurs catégories peuvent être importées simultanément.
  • DATA_CENTER_FILE : type de fichier. Importe les fichiers spécifiés depuis Données d'application. Plusieurs fichiers peuvent être importés simultanément.
Si ce paramètre est défini sur DATA_CENTER_CATEGORY, vous devez spécifier le paramètre CategoryIds. Si ce paramètre est défini sur DATA_CENTER_FILE, vous devez spécifier le paramètre DocumentIds.
Pour créer une base de connaissances vide, utilisez une catégorie vide ne contenant aucun fichier : définissez ce paramètre sur DATA_CENTER_CATEGORY et transmettez l'identifiant de la catégorie vide dans CategoryIds.
Valeurs valides :
  • DATA_CENTER_CATEGORY : type de catégorie.
  • DATA_CENTER_FILE : type de fichier.
DATA_CENTER_FILE
DocumentIdsarrayNonLa liste des fichiers à importer lors de la création de la base de connaissances. Spécifiez les identifiants des fichiers ici. Nous recommandons de ne pas importer plus de 10 000 fichiers. Pour les fichiers restants, appelez l'opération SubmitIndexAddDocumentsJob pour continuer l'importation.
stringNonL'identifiant du fichier, qui correspond au FileId renvoyé par l'opération AddFile, ou obtenu en cliquant sur l'icône d'identifiant à côté du nom du fichier dans l'onglet Fichiers du connecteur de fichiers Données d'application.file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
CategoryIdsarrayNonLa liste des identifiants de catégories à importer lors de la création de la base de connaissances. Tous les fichiers sous les catégories spécifiées sont importés. Nous recommandons de ne pas importer plus de 500 fichiers. Pour les fichiers restants, appelez l'opération SubmitIndexAddDocumentsJob pour continuer l'importation.
stringNonL'identifiant de la catégorie, qui correspond au CategoryId renvoyé par l'opération AddCategory, ou obtenu en cliquant sur l'icône d'identifiant à côté du nom de la catégorie dans l'onglet Fichiers du connecteur de fichiers <props="intl">[Données d'application](https://modelstudio.console.alibabacloud.com/?tab=app#/data-center.ca_hiu2383nfxxxx
TableIdsarrayNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
stringNon
SinkTypestringOuiLe type de stockage vectoriel de la base de connaissances. Pour plus d'informations, consultez Base de connaissances. Valeurs valides :
  • BUILT_IN : les données vectorielles sont hébergées sur la plateforme Alibaba Cloud Model Studio.
  • ADB : base de données AnalyticDB for PostgreSQL. Si vous avez besoin de fonctionnalités avancées telles que la gestion, l'audit et la surveillance de la base de données, sélectionnez ADB.
Si vous n'avez jamais utilisé le stockage ADB sur Alibaba Cloud Model Studio, accédez à la page Créer une base de connaissances, sélectionnez ADB-PG comme type de stockage vectoriel et procédez à l'autorisation comme indiqué. Si vous spécifiez ADB, vous devez renseigner les paramètres SinkInstanceId et SinkRegion.
Valeurs valides :
  • BUILT_IN : BUILT_IN.
  • ADB : ADB.
BUILT_IN
SinkInstanceIdstringNonL'identifiant de l'instance AnalyticDB for PostgreSQL (requis uniquement lorsque SinkType est défini sur ADB). Obtenez cet identifiant sur la page Liste des instances AnalyticDB for PostgreSQL.gp-bp32109xxxx
SinkRegionstringNonLa région de l'instance AnalyticDB for PostgreSQL (requise uniquement lorsque SinkType est défini sur ADB). Appelez DescribeRegions pour obtenir la liste des régions.cn-hangzhou
Columnsarray<object>Non
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
objectNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
ColumnstringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
école
IsRecallbooleanNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
true
IsSearchbooleanNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
true
NamestringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
École
TypestringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
string
DescriptionstringNonLa description de la base de connaissances. La description peut comporter jusqu'à 1000 caractères. Valeur par défaut : vide.La bibliothèque de documents d'aide de l'entreprise comprend des documents importants tels que les politiques de l'entreprise et les catalogues de produits
metaExtractColumnsarray<object>NonLa configuration d'extraction des métadonnées. Les métadonnées sont un ensemble d'attributs supplémentaires liés au contenu des données non structurées. Ces attributs sont intégrés dans les fragments de texte sous forme de paires clé-valeur. Pour plus d'informations, consultez Base de connaissances.
objectNon
KeystringNonLe champ de métadonnées. Le champ doit comporter entre 1 et 50 caractères et ne peut contenir que des lettres et des traits de soulignement. Si ce paramètre est spécifié, vous devez également spécifier les paramètres Value et Type.author
ValuestringNonLa valeur du champ de métadonnées.Tim
TypestringNonLa méthode d'extraction pour le champ de métadonnées. Valeurs valides :
  • constant : Constante.
  • variable : Variable.
  • custom_prompt : Grand modèle de langage.
  • regular : Expression régulière.
  • keywords : Recherche par mots-clés.
Valeurs valides :
  • constant : Extraction par constante.
  • keywords : Extraction par mots-clés.
  • custom_prompt : Grand modèle de langage.
  • variable : Extraction par variable.
  • regular : Expression régulière.
constant
DescstringNonLa description en chinois du champ de métadonnées. La description peut comporter jusqu'à 1 000 caractères et peut contenir des caractères chinois, des lettres, des chiffres, des traits de soulignement (_), des traits d'union (-), des points (.) et des deux-points (:). Valeur par défaut : vide.AuthorName
EnableLlmbooleanNonIndique si ce champ de métadonnées et sa valeur participent au processus de génération de réponses du grand modèle de langage avec le contenu du fragment de texte. Valeurs valides :
  • true : Activé.
  • false : Désactivé.
Valeur par défaut : false.Valeurs valides :
  • true : Activé.
  • false : Désactivé.
false
EnableSearchbooleanNonIndique si ce champ de métadonnées et sa valeur participent à la récupération dans la base de connaissances avec le contenu du fragment de texte. Valeurs valides :\n\n- true : Activé.\n- false : Désactivé.\n\nValeur par défaut : false.Valeurs valides :
  • true : Activé.
  • false : Désactivé.
false
enableHeadersbooleanNonIndique si la première ligne de tous les fichiers xlsx et xls doit être traitée comme des en-têtes et concaténée à chaque bloc de texte, empêchant ainsi le grand modèle de langage de traiter les en-têtes comme des lignes de données ordinaires.
Activez cette fonctionnalité uniquement lorsque tous les fichiers importés sont au format .xlsx ou .xls et contiennent des en-têtes. Dans le cas contraire, ne l'activez pas.
Valeurs valides :
  • true : Activé.
  • false : Désactivé.
Si aucune valeur n'est spécifiée, cette fonctionnalité est désactivée par défaut.Valeurs valides :
  • true : Activé.
  • false : Désactivé.
false
chunkModestringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
Valeurs valides :
  • regex : Fragmentation par expression régulière.
  • length : Fragmentation par longueur.
  • h1 : Fragmentation par titres de premier niveau.
  • h2 : Fragmentation par titres de deuxième niveau.
  • page : Fragmentation par page.
regex
EnableRewritebooleanNonIndique si la réécriture des conversations multi-tours doit être activée. Valeurs valides :
  • true : Activé.
  • false : Désactivé.
Si ce paramètre n'est pas spécifié, cette fonctionnalité est activée par défaut.Valeurs valides :
  • true : Activé.
  • false : Désactivé.
true
CreateIndexTypestringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
standard
pipelineCommercialTypestringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
standard
pipelineCommercialCuintegerNon<props="china">Le nombre de RCU pour la base de connaissances (requis uniquement lorsque pipelineCommercialType est défini sur enterprise). Plage de valeurs : [1-200].1
pipelineRetrieveRateLimitStrategystringNon
Ce paramètre n'est pas disponible. Ne transmettez pas ce paramètre.
downgrade
knowledgeTypestringNonLe code de la source de données. Obligatoire lors de la création d'une base de connaissances de requête de données. Utilisé conjointement avec les paramètres de table et de base de données.
  • Cette opération ne prend pas en charge l'association de bases de données personnalisées. Utilisez la console Alibaba Cloud Model Studio pour les créer.
260xxx
RerankModestringNonLe nom de la table de données. Obligatoire lors de la création d'une base de connaissances de requêtes de données.La table de données doit exister dans la source de données spécifiée par connectId ou datasourceCode.Valeurs valides :
  • similar: 相似模式。 : similar: 相似模式。
  • custom: 自定义模式。 : custom: 自定义模式。
  • qa:(默认值) 问答模式。 : qa:(默认值) 问答模式。
lance
RerankInstructstringNonLe nom de la base de données. Obligatoire lors de la création d'une base de connaissances de requête de données.La base de données doit exister dans la source de données spécifiée par datasourceCode.database_a6eacabe6
NonCe paramètre n'est pas disponible. Ne transmettez pas ce paramètre.document
NonCe paramètre n'est pas disponible. Ne transmettez pas ce paramètre.basic_document_qa
NonCe paramètre n'est pas disponible. Ne transmettez pas ce paramètre.conn_mysql_xxx_xxx
Nonconnector
NonCe paramètre n'est pas disponible. Ne transmettez pas ce paramètre. [_single.params.RerankMode.enum.similar: 相似模式。]similar : Mode de similarité. [_single.params.RerankMode.enum.custom: 自定义模式。]custom : Mode personnalisé. [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa : (Par défaut) Mode Q&R. [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar : Mode de similarité. [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom : Mode personnalisé. [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa : (Par défaut) Mode Q&R. [_single.params.RerankMode.enum.similar: 相似模式。]similar : Mode de similarité. [_single.params.RerankMode.enum.custom: 自定义模式。]custom : Mode personnalisé. [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa : (Par défaut) Mode Q&R.Valeurs valides :
  • similar: 相似模式。 : similar: 相似模式。
  • custom: 自定义模式。 : custom: 自定义模式。
  • qa:(默认值) 问答模式。 : qa:(默认值) 问答模式。
qa
NonCe paramètre n'est pas disponible. Ne transmettez pas ce paramètre.

Éléments de réponse

ÉlémentTypeDescriptionExemple
objectSchéma de la réponse.
CodestringLe code d'état d'erreur.
DataobjectLes données métier renvoyées lorsque la requête aboutit.
IdstringL'identifiant de la base de connaissances, également appelé IndexId. Il s'agit de l'identifiant unique de la base de connaissances créée.
Conservez soigneusement cette valeur. Elle est requise pour toutes les opérations d'API ultérieures liées à cette base de connaissances.
jkurxhxxxx
MessagestringLe message d'erreur.
RequestIdstringL'identifiant de la requête.17204B98-xxxx-4F9A--2446A84821CA
StatusstringLe code d'état renvoyé par l'opération."200"
SuccessbooleanIndique si la requête a réussi. Valeurs valides :
  • true : succès.
  • false : échec.
true

Exemples

正常返回示例 JSON format
{
  "Code": "",
  "Data": {
    "Id": "jkurxhxxxx"
  },
  "Message": "",
  "RequestId": "17204B98-xxxx-4F9A--2446A84821CA",
  "Status": "\"200\"",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.