Skip to main content

SubmitIndexAddDocumentsJob

Ajoute des fichiers analysés à une base de connaissances spécifiée.

Description de l'opération

  • Cette opération ne prend pas en charge les bases de connaissances de requête de données ou de questions-réponses sur les images. Pour plus d'informations sur la mise à jour des bases de connaissances de requête de données ou de questions-réponses sur les images, consultez les instructions de mise à jour de la base de connaissances dans Base de connaissances.
  • Les utilisateurs de Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Model Studio (nécessitant AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:SubmitIndexAddDocumentsJob), 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).
  • Avant d'appeler cette opération, appelez l'opération AddFile pour téléverser les fichiers que vous souhaitez ajouter à Model Studio.
  • Après l'appel de cette opération, le nœud nécessite du temps pour s'exécuter et peut prendre plusieurs heures pendant les périodes de pointe. Ne soumettez pas de requêtes en double avant que le nœud ne soit terminé. Pour interroger l'état d'exécution du nœud, appelez l'opération GetIndexJobStatus. La liste de fichiers Documents renvoyée par cette opération contient tous les fichiers de cette tâche d'ajout (identifiés de manière unique par le job_id que vous fournissez), et vous pouvez vérifier si chaque fichier a été importé (analysé) avec succès. Notez qu'un appel trop fréquent de GetIndexJobStatus déclenchera une limitation de débit. Ne dépassez pas une fréquence de 20 appels par minute.
  • Une fois cette opération appelée avec succès, son exécution prend un certain temps. Ne soumettez pas de requêtes en double avant que la réponse ne soit renvoyée. Cette opération n'est pas idempotente.
Limite de débit : Les appels fréquents à cette opération seront limités. Ne dépassez pas 10 appels par seconde. En cas de limitation, 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:SubmitIndexAddDocumentsJob

create

*All Resource

*

AucuneAucune

Syntaxe de la requête

POST /{WorkspaceId}/index/add_documents_to_index 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-3shx2gu255oqxxxx

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
SourceTypestringOuiLe type de source de données. Valeurs valides :
  • DATA_CENTER_CATEGORY : type de catégorie. Importe tous les documents sous les catégories spécifiées dans Données d'application. Plusieurs catégories sont prises en charge.
  • DATA_CENTER_FILE : type de document. Importe les fichiers spécifiés depuis Données d'application. Plusieurs fichiers sont pris en charge.
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.
Valeurs valides :
  • DATA_CENTER_CATEGORY : Type de catégorie.
  • DATA_CENTER_FILE : Type de document.
DATA_CENTER_FILE
DocumentIdsarrayNonLa liste des identifiants de fichiers.
stringNonL'identifiant du fichier, qui correspond au FileId renvoyé par l'opération AddFile. Vous pouvez également obtenir l'identifiant du fichier sur la page Données d'application en cliquant sur l'icône d'identifiant à côté du nom du fichier.doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx
CategoryIdsarrayNonLa liste des identifiants de catégories.
stringNonL'identifiant de la catégorie, qui correspond au CategoryId renvoyé par l'opération AddCategory. Vous pouvez également obtenir l'identifiant de la catégorie dans l'onglet Fichiers de la page Données d'application en cliquant sur l'icône d'identifiant à côté de la catégorie.cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
ChunkModestringNon
Ce paramètre n'est pas encore disponible. Ne spécifiez pas ce paramètre.
length
SeparatorstringNon
Ce paramètre n'est pas encore disponible. Ne spécifiez pas ce paramètre.
(?<=。)
ChunkSizeintegerNon
Ce paramètre n'est pas encore disponible. Ne spécifiez pas ce paramètre.
128
OverlapSizeintegerNon
Ce paramètre n'est pas encore disponible. Ne spécifiez pas ce paramètre.
16
EnableHeadersbooleanNonIndique si l'assemblage des en-têtes pour les fichiers Excel doit être activé. Lorsqu'il est activé, la base de connaissances traite la première ligne de tous les fichiers xlsx et xls comme des en-têtes et les ajoute automatiquement à chaque fragment de texte (ligne de données), 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. Sinon, laissez-la désactivée.
Valeurs valides :
  • true : Activé.
  • false : Désactivé.
Valeur par défaut : false.Valeurs valides :
  • true : Activé.
  • false : Désactivé.
false
ExtraobjectNon
uniqueIdstringNon

Éléments de réponse

ÉlémentTypeDescriptionExemple
objectSchéma de la réponse.
RequestIdstringL'identifiant de la requête.778C0B3B-xxxx-5FC1-A947-36EDD13606AB
DataobjectLes données métier renvoyées par l'opération.
IdstringL'identifiant de la tâche, également connu sous le nom de JobId.42687eb254a34802bed398357f5498ae
StatusstringLe code d'état renvoyé par l'opération.200
SuccessbooleanIndique si l'opération a réussi. Valeurs valides :
  • true : Réussi.
  • false : Échec.
true
MessagestringLe message d'erreur.Required parameter(%s) missing or invalid, please check the request parameters
CodestringLe code d'erreur.Index.InvalidParameter

Exemples

正常返回示例 JSON format
{
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

Codes d'erreur

Code de statut HTTP

Code d'erreur

Message d'erreur

Description

400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.