AddFilesFromAuthorizedOss - Alibaba Cloud Model Studio - Centre de documentation Alibaba Cloud

Importe des fichiers depuis un compartiment OSS autorisé vers les données d'application d'Alibaba Cloud Model Studio.

Description de l'opération

Assurez-vous que le compartiment OSS appartient au même compte Alibaba Cloud que Model Studio et que l'autorisation a été effectuée comme décrit dans Instructions de configuration de l'importation de données depuis OSS.
- Les types de stockage de compartiment pris en charge n'incluent pas Archive, Cold Archive ou Deep Cold Archive. Les compartiments avec chiffrement de contenu activé sont pris en charge. Les compartiments avec accès en lecture/écriture publique, lecture publique ou privé sont pris en charge.
- Pour utiliser un compartiment avec la protection contre le hotlinking basée sur le Referer activée, ajoutez le nom de domaine *.console.alibabacloud.com à la liste blanche des Referer comme décrit dans Autoriser l'accès uniquement depuis des sites web de confiance.
Les utilisateurs de Resource Access Management (RAM) doivent d'abord obtenir les autorisations d'API pour Model Studio (l'autorisation AliyunBailianDataFullAccess est requise, qui inclut l'autorisation sfm:AddFilesFromAuthorizedOss) et rejoindre un espace de travail avant d'appeler cette opération. Les comptes Alibaba Cloud peuvent appeler cette opération directement sans autorisation. Appelez cette opération en utilisant la dernière version du SDK Model Studio.
Cette opération n'est pas idempotente.

Limite de fréquence : Cette opération est limitée si elle est appelée trop fréquemment. Ne dépassez pas 5 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:AddFilesFromAuthorizedOss	create	All Resource ``	Aucune	Aucune

Action

Niveau d'accès

Type de ressource

Clé de condition

Action dépendante

sfm:AddFilesFromAuthorizedOss

create

*All Resource

*

Aucune

Syntaxe de la requête

POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
WorkspaceId	string	Oui	L'identifiant de l'espace de travail. Les fichiers sont importés dans cet espace de travail. 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-3z7uw7fwz0vxxxx

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
CategoryId	string	Oui	L'identifiant de la catégorie dans laquelle les fichiers sont importés. Il s'agit du CategoryId renvoyé par l'opération AddCategory. Vous pouvez également obtenir l'identifiant de la catégorie en cliquant sur l'icône d'identifiant à côté du nom de la catégorie dans l'onglet Données d'application - Fichiers. Vous pouvez transmettre default pour utiliser la catégorie par défaut créée par le système.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
CategoryType	string	Oui	Le type de catégorie. Facultatif. Valeur par défaut : UNSTRUCTURED. Valeurs valides : UNSTRUCTURED : catégorie pour la création de scénarios de base de connaissances. Valeurs valides : UNSTRUCTURED : UNSTRUCTURED.	UNSTRUCTURED
OssRegionId	string	Oui	L'identifiant de la région du compartiment OSS. Pour plus d'informations, consultez Régions et points de terminaison OSS.	cn-beijing
OssBucketName	string	Oui	Le nom du compartiment OSS. Pour plus d'informations, consultez Compartiments.	bucketNamexxxxx
FileDetails	array<object>	Oui	La liste des fichiers à importer. Un maximum de 10 fichiers peut être téléversé à la fois. RemarqueUn maximum de 10 fichiers peut être téléversé à la fois.
	array<object>	Oui	L'objet fichier.
FileName	string	Oui	Le nom du fichier à importer. Le nom du fichier doit inclure l'extension du format de fichier. Formats pris en charge : pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp et gif. Le nom du fichier doit comporter entre 4 et 128 caractères. Pour les exigences et les limites de téléversement de fichiers, consultez Quotas et limites de la base de connaissances. ImportantSi le nom du fichier importé est identique à celui d'un fichier existant dans la base de connaissances, l'opération renvoie tout de même un Status de SUCCESS, mais le fichier n'est pas réellement importé. Le fichier existant portant le même nom reste inchangé. Assurez-vous que chaque nom de fichier importé est unique. RemarquePour créer une table de données et téléverser des données, utilisez la console Model Studio. Cela n'est pas pris en charge via l'API.	this_is_temp_xxxx.pdf
OssKey	string	Oui	La clé du fichier dans le compartiment OSS. Pour plus d'informations, consultez Conventions de nommage des objets.	root/path/this_is_temp_xxxx.pdf
Parser	string	Non	Le type d'analyseur. Valeurs valides : DOCMIND : analyse intelligente de documents. DOCMIND_DIGITAL : analyse de documents électroniques. DOCMIND_LLM_VERSION : analyse de documents basée sur LLM. DASH_QWEN_VL_PARSER : analyse Qwen VL. DOCMIND_LLM_VERSION_MEDIA : analyse audio et vidéo. AUTO_SELECT : sélection automatique de l'analyseur. RemarqueLe fichier téléversé est analysé à l'aide de l'analyseur spécifié. Si vous définissez ce paramètre sur AUTO_SELECT, l'analyseur configuré pour la catégorie est utilisé.	AUTO_SELECT
ParserConfig	object	Non	La configuration de l'analyseur. Ce paramètre est requis uniquement lorsque le type d'analyseur est défini sur analyse Qwen VL.
ModelName	string	Non	Le nom du modèle.	qwen3-vl-plus
ModelPrompt	string	Non	L'invite utilisée lors de l'appel de l'analyse Qwen VL.	#角色你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。任务目标请结合输入图片，详细描述图片中的内容
Tags	array	Non	La liste des balises associées au fichier. Valeur par défaut : vide, ce qui signifie que le fichier n'est associé à aucune balise. Un maximum de 10 balises peut être spécifié.
	string	Non	La balise du fichier. Chaque balise peut comporter jusqu'à 12 caractères et prend en charge les caractères de la catégorie des lettres Unicode (y compris les lettres anglaises, les caractères chinois et les chiffres), les traits de soulignement (_) et les traits d'union (-).	产品介绍
OverWriteFileByOssKey	boolean	Non	Indique si les fichiers avec la même OssKey dans la catégorie doivent être écrasés. Valeur par défaut : false, ce qui signifie que les fichiers ne sont pas écrasés.	false

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Code	string	Le code d'erreur.	success
Data	object	Le champ de données renvoyé par l'opération.
AddFileResultList	array<object>	La liste des résultats d'importation de fichiers.
	object	La liste des résultats d'importation de fichiers.
FileId	string	The file ID. Keep this value safe because it is required for all subsequent API operations related to this file.	file_809f469a59ac449586ec692576xxxxx_102248XXX
OssKey	string	The key of the imported file in the OSS bucket.	root/path/this_is_temp_xxxx.pdf
Status	string	The file import status. Valid values: SUCCESS: The import to application data is complete. FAILED: The import to application data failed. RemarqueOnly files with a SUCCESS status can be used to create or update a knowledge base.	SUCCESS
Msg	string	The error message returned when the file import fails.	size too large
Message	string	Le message d'erreur.	Cant find out category for category_id param
RequestId	string	L'identifiant de la requête.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	Le code d'état renvoyé par l'opération.	200
Success	string	Indique si l'appel a réussi. Valeurs valides : true : réussi. false : échoué.	true

Exemples

正常返回示例

JSON format

{
  "Code": "success",
  "Data": {
    "AddFileResultList": [
      {
        "FileId": "file_809f469a59ac449586ec692576xxxxx_102248XXX",
        "OssKey": "root/path/this_is_temp_xxxx.pdf",
        "Status": "SUCCESS",
        "Msg": "size too large"
      }
    ]
  },
  "Message": "Cant find out category for category_id param.",
  "RequestId": "17204B98-xxxx-4F9A-8464-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.