Solicite un arrendamiento de carga para subir archivos de base de conocimientos o archivos para interacciones conversacionales de aplicaciones de agente.
Descripción de la operación
- Los usuarios de RAM (subcuentas) deben obtener primero los permisos de API para Alibaba Cloud Model Studio (requiere
AliyunBailianDataFullAccess, que incluye el permiso sfm:ApplyFileUploadLease) y unirse a un espacio de trabajo antes de llamar a esta API. Las cuentas de Alibaba Cloud (cuentas principales) pueden llamar directamente a esta API sin autorización. Le recomendamos que llame a esta API utilizando el más reciente SDK de Alibaba Cloud Model Studio. - Esta API no es idempotente.
Limitación: Esta API está sujeta a limitaciones si se llama con demasiada frecuencia. La frecuencia no debe exceder 10 llamadas por segundo. Si se aplica la limitación, inténtelo de nuevo más tarde.
Probar ahora
Pruebe esta API en OpenAPI Explorer; no es necesaria la firma manual. Las llamadas exitosas generan automáticamente código SDK que coincide con sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.
Autorización de RAM
La siguiente tabla describe la autorización necesaria para llamar a esta API. Puede definirla en una política de Resource Access Management (RAM). Las columnas de la tabla se detallan a continuación:
-
Action: Las acciones se pueden utilizar en el elemento
Actionde las declaraciones de políticas de permisos de RAM para otorgar permisos para realizar la operación. -
API: La API que puede llamar para realizar la acción.
-
Nivel de acceso: El nivel de acceso predefinido otorgado para cada API. Valores válidos: create, list, get, update y delete.
-
Tipo de recurso: El tipo de recurso que admite la autorización para realizar la acción. Indica si la acción admite permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción. De lo contrario, la política será ineficaz.
- Para las API con permisos a nivel de recurso, los tipos de recursos requeridos están marcados con un asterisco (*). Especifique el Nombre de recurso de Alibaba Cloud (ARN) correspondiente en el elemento
Resourcede la política. - Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento
Resourcede la política.
- Para las API con permisos a nivel de recurso, los tipos de recursos requeridos están marcados con un asterisco (*). Especifique el Nombre de recurso de Alibaba Cloud (ARN) correspondiente en el elemento
-
Clave de condición: Las claves de condición definidas por el servicio. La clave permite un control granular, aplicándose ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de claves de condición comunes aplicables a todos los servicios compatibles con RAM.
-
Acción dependiente: Las acciones dependientes necesarias para ejecutar la acción. Para completar la acción, el usuario de RAM o el rol de RAM debe tener los permisos para realizar todas las acciones dependientes.
Acción | Nivel de acceso | Tipo de recurso | Clave de condición | Acción dependiente |
|---|---|---|---|---|
sfm:ApplyFileUploadLease | none | *Todos los recursos
| None | None |
Sintaxis de la solicitud
POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1
Parámetros de ruta
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
| CategoryId | string | Sí | Al cargar archivos para crear una base de conocimiento:
Para crear una nueva tabla de datos y cargar datos, utilice la consola de Alibaba Cloud Model Studio. Esto no es compatible a través de la API.
| cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| WorkspaceId | string | Sí | El ID del espacio de trabajo al que pertenece el archivo cargado. Para obtener información sobre cómo obtener el ID del espacio de trabajo, consulte Cómo usar espacios de trabajo. | llm-3z7uw7fwz0vexxxx |
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
| FileName | string | Sí | Al cargar archivos para crear una base de conocimiento:
Para crear una nueva tabla de datos y cargar datos, utilice la consola de Alibaba Cloud Model Studio. Esto no es compatible a través de la API. | XXXX-product-catalog.pdf |
| Md5 | string | Sí | El valor MD5 del archivo cargado. El servidor verificará este campo (actualmente no habilitado). Por favor, complete el valor correcto. | 19657c391f6c70bcea63c154d8606bb3 |
| SizeInBytes | string | Sí | El tamaño del archivo cargado en bytes. El servidor verificará este campo (actualmente no habilitado). Por favor, complete el valor correcto. Valores válidos: 1 B a 100 MB. | 1000 |
| CategoryType | string | No | El tipo de categoría. Si no se especifica este parámetro, el valor predeterminado es UNSTRUCTURED. Valores válidos: UNSTRUCTURED: categoría para crear escenarios de base de conocimiento. SESSION_FILE: cargar archivos para interacciones conversacionales de aplicaciones de agente. Para crear una nueva tabla de datos y cargar datos, utilice la consola de Alibaba Cloud Model Studio. Esto no es compatible a través de la API. | UNSTRUCTURED |
| UseInternalEndpoint | boolean | No | Si ha habilitado el almacenamiento seguro de Alibaba Cloud Model Studio y necesita generar una URL de arrendamiento que solo sea accesible desde la red interna de Alibaba Cloud en la misma región, puede configurar este parámetro en true para mejorar la seguridad. Si no se especifica este parámetro, el valor predeterminado es false, lo que genera una URL de arrendamiento accesible públicamente. Si no ha habilitado el almacenamiento seguro de Alibaba Cloud Model Studio, o no está seguro de si lo está utilizando, no establezca este parámetro en true (la carga fallará). | false |
Elementos de respuesta
Elemento | Tipo | Descripción | Ejemplo |
|---|---|---|---|
object | Esquema de la respuesta | ||
| Code | string | El código de error. | DataCenter.FileTooLarge |
| Data | object | Los datos devueltos. | |
| FileUploadLeaseId | string | El ID único del lease. Necesita utilizar este parámetro cuando llame a la API AddFile. | 1e6a159107384782be5e45ac4759b247.1719325231035 |
| Param | object | Los parámetros de solicitud HTTP para cargar el archivo. | |
| Headers | any | Los pares clave-valor para incluir en el encabezado de la solicitud HTTP. Tanto las claves como los valores son cadenas. El Content-Type devuelto puede estar vacío. Utilice el valor vacío tal cual al cargar. | "X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf" |
| Método | string | El método HTTP. Valores válidos:
| PUT |
| Url | string | La URL de carga para el archivo. Esta URL es una URL prefirmada. No admite cargas de FormData. Utilice la carga binaria en su lugar. | |
| Tipo | string | El método de carga del archivo. Valores válidos:
| HTTP |
| Message | string | El mensaje de error. | Usuario no autorizado para operar en el recurso especificado |
| RequestId | string | El ID de la solicitud. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Status | string | El código de estado devuelto. | 200 |
| Success | boolean | Indica si la llamada a la API es exitosa. Valores válidos:
| true |
Ejemplos
Respuesta exitosa
Formato JSON
{
"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
}
Códigos de error
Consulte Códigos de error para obtener una lista completa.
Notas de lanzamiento
Consulte Notas de lanzamiento para obtener una lista completa.