Demande un bail de téléversement pour charger des fichiers de base de connaissances ou des fichiers destinés aux interactions conversationnelles des applications d'agent.
Description de l'opération
- Les utilisateurs RAM (sous-comptes) doivent d'abord obtenir les autorisations d'API pour Alibaba Cloud Model Studio (nécessite
AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ApplyFileUploadLease), et rejoindre un espace de travail avant d'appeler cette API. Les comptes Alibaba Cloud (comptes principaux) peuvent appeler directement cette API sans autorisation. Nous vous recommandons d'appeler cette API en utilisant la dernière version du SDK Alibaba Cloud Model Studio. - Cette API n'est pas idempotente.
Limitation du débit : Cette API est soumise à une limitation du débit si elle est appelée trop fréquemment. La fréquence ne doit pas dépasser 10 appels par seconde. En cas de limitation, veuillez réessayer 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
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:ApplyFileUploadLease | none | *All Resource
| Aucune | Aucune |
Syntaxe de la requête
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
Paramètres de chemin
| Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
CategoryId | string | Oui | Lors du téléversement de fichiers pour la création d'une base de connaissances :
RemarquePour créer une nouvelle table de données et téléverser des données, utilisez la console Alibaba Cloud Model Studio. Cela n'est pas pris en charge via l'API.
| cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
WorkspaceId | string | Oui | L'identifiant de l'espace de travail auquel appartient le fichier téléversé. Pour plus d'informations sur la façon d'obtenir l'identifiant de l'espace de travail, consultez Comment utiliser les espaces de travail. | llm-3z7uw7fwz0vexxxx |
Paramètres de requête
| Paramètre | Type | Requis | Description | Exemple |
|---|---|---|---|---|
FileName | string | Oui | Lors du téléversement de fichiers pour la création d'une base de connaissances :
RemarquePour créer une nouvelle table de données et téléverser des données, utilisez la console Alibaba Cloud Model Studio. Cela n'est pas pris en charge via l'API. | XXXX_product_list.pdf |
Md5 | string | Oui | La valeur MD5 du fichier téléversé. Le serveur vérifiera ce champ (actuellement non activé). Veuillez renseigner la valeur correcte. | 19657c391f6c70bcea63c154d8606bb3 |
SizeInBytes | string | Oui | La taille du fichier téléversé en octets. Le serveur vérifiera ce champ (actuellement non activé). Veuillez renseigner la valeur correcte. Valeurs valides : de 1 o à 100 Mo. | 1000 |
CategoryType | string | Non | Le type de catégorie. Si ce paramètre n'est pas spécifié, la valeur par défaut est UNSTRUCTURED. Valeurs valides : UNSTRUCTURED : catégorie pour la création de scénarios de base de connaissances. SESSION_FILE : téléversement de fichiers pour les interactions conversationnelles des applications d'agent. RemarquePour créer une nouvelle table de données et téléverser des données, utilisez la console Alibaba Cloud Model Studio. Cela n'est pas pris en charge via l'API. | UNSTRUCTURED |
UseInternalEndpoint | boolean | Non | Si vous avez activé le stockage sécurisé d'Alibaba Cloud Model Studio et que vous devez générer une URL de bail accessible uniquement depuis le réseau interne d'Alibaba Cloud dans la même région, vous pouvez définir ce paramètre sur true pour améliorer la sécurité. Si ce paramètre n'est pas spécifié, la valeur par défaut est false, ce qui génère une URL de bail accessible publiquement. RemarqueSi vous n'avez pas activé le stockage sécurisé d'Alibaba Cloud Model Studio, ou si vous n'êtes pas sûr de l'utiliser, ne définissez pas ce paramètre sur true (le téléversement échouera). | false |
Éléments de réponse
| Élément | Type | Description | Exemple |
|---|---|---|---|
object | Schéma de la réponse. | ||
Code | string | Le code d'erreur. | DataCenter.FileTooLarge |
Data | object | Les données renvoyées. | |
FileUploadLeaseId | string | L'identifiant unique du bail. Vous devez utiliser ce paramètre lorsque vous appelez l'API AddFile. | 1e6a159107384782be5e45ac4759b247.1719325231035 |
Param | object | Les paramètres de requête HTTP pour le téléversement du fichier. | |
Headers | any | Key-value pairs that need to be included in the header. Both keys and values are strings. RemarqueThe returned Content-Type may be empty. You can upload the file with the empty value. | "X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf" |
Method | string | The HTTP method. Valid values:
| PUT |
Url | string | The upload URL of the file. RemarqueThis URL is a pre-signed URL. FormData upload is not supported. You must upload the file in binary mode. | |
Type | string | La méthode de téléversement du fichier. Valeurs valides :
| HTTP |
Message | string | Le message d'erreur. | Utilisateur non autorisé à effectuer des opérations sur la ressource spécifiée |
RequestId | string | L'identifiant de la requête. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
Status | string | Le code d'état renvoyé. | 200 |
Success | boolean | Indique si l'appel d'API a réussi. Valeurs valides :
| true |
Exemples
正常返回示例
JSON format
{
"Code": "DataCenter.FileTooLarge",
"Data": {
"FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
"Param": {
"Headers": "\"X-bailian-extra\":\"MTAwNTQyNjQ5NTE2OTE3OA==\",\n\"Content-Type\":\"application/pdf\"",
"Method": "PUT",
"Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=YOUR_ACCESS_KEY_ID&Signature=YOUR_SIGNATURE"
},
"Type": "HTTP"
},
"Message": "User not authorized to operate on the specified resource",
"RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
"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.