Importa archivos desde un bucket de OSS autorizado a los datos de la aplicación de Alibaba Cloud Model Studio.
Descripción de la operación
-
Asegúrese de que el bucket de OSS pertenezca a la misma cuenta de Alibaba Cloud que Model Studio y de que la autorización se haya completado como se describe en Instrucciones de configuración para importar datos desde OSS.
- Los tipos de almacenamiento de bucket compatibles no incluyen Archive, Cold Archive ni Deep Cold Archive. Se admiten buckets con cifrado de contenido habilitado. Se admiten buckets con acceso de lectura/escritura pública, lectura pública o privado.
- Para utilizar un bucket con protección contra hotlinking basada en Referer habilitada, agregue el nombre de dominio
*.console.alibabacloud.coma la lista blanca de Referer como se describe en Permitir acceso solo desde sitios web de confianza.
-
Los usuarios de Resource Access Management (RAM) deben obtener primero permisos de API para Model Studio (se requiere el permiso
AliyunBailianDataFullAccess, que incluye el permiso sfm:AddFilesFromAuthorizedOss) y unirse a un espacio de trabajo antes de invocar esta operación. Las cuentas de Alibaba Cloud pueden invocar esta operación directamente sin autorización. Llame a esta operación utilizando el SDK de Model Studio más reciente. -
Esta operación no tiene idempotencia.
Límite de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda 5 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 las acciones o a las 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:AddFilesFromAuthorizedOss | create | *Todos los recursos
| None | None |
Sintaxis de la solicitud
POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1
Parámetros de ruta
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
| WorkspaceId | string | Sí | El ID del espacio de trabajo. Los archivos se importan a este espacio de trabajo. Para obtener más información sobre cómo obtener el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo. | llm-3z7uw7fwz0vxxxx |
Parámetros de solicitud
Parámetro | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
| CategoryId | string | Sí | El ID de la categoría a la que se importan los archivos. Este es el | cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
| CategoryType | string | Sí | El tipo de categoría. Opcional. Valor predeterminado: UNSTRUCTURED. Valores válidos:
Valores válidos:
| UNSTRUCTURED |
| OssRegionId | string | Sí | El ID de región del bucket de OSS. Para obtener más información, consulte Regiones y endpoints de OSS. | cn-beijing |
| OssBucketName | string | Sí | El nombre del bucket de OSS. Para obtener más información, consulte Buckets. | bucketNamexxxxx |
| FileDetails | array<object> | Sí | La lista de archivos a importar. Se pueden cargar un máximo de 10 archivos a la vez. Se pueden cargar un máximo de 10 archivos a la vez. | |
array<object> | Sí | El objeto de archivo. | ||
| FileName | string | Sí | El nombre del archivo a importar. El nombre del archivo debe incluir la extensión del formato de archivo.
Si el nombre del archivo importado es igual al de un archivo existente en la base de conocimiento, la operación aún devuelve un Status de SUCCESS, pero el archivo no se importa realmente. El archivo existente con el mismo nombre permanece sin cambios. Asegúrese de que cada nombre de archivo importado sea único.Para crear una tabla de datos y cargar datos, utilice la consola de Model Studio. Esto no es compatible a través de la API. | this_is_temp_xxxx.pdf |
| OssKey | string | Sí | La clave del archivo en el bucket de OSS. Para obtener más información, consulte Convenciones de nomenclatura de objetos. | root/path/this_is_temp_xxxx.pdf |
| Parser | string | No | El tipo de analizador. Valores válidos:
El archivo cargado se analiza utilizando el analizador especificado. Si establece este parámetro en AUTO_SELECT, se utiliza el analizador configurado para la categoría. | AUTO_SELECT |
| ParserConfig | object | No | La configuración del analizador. Este parámetro es obligatorio solo cuando el tipo de analizador se establece en análisis VL de Qwen. | |
| ModelName | string | No | El nombre del modelo. | qwen3-vl-plus |
| ModelPrompt | string | No | El prompt utilizado al llamar al análisis VL de Qwen. | # Rol Eres un anotador profesional de contenido de imágenes, experto en reconocer y describir el contenido de las imágenes. # Objetivo de la tarea Describe detalladamente el contenido de la imagen de entrada. |
| Tags | array | No | La lista de etiquetas asociadas con el archivo. Valor predeterminado: vacío, lo que significa que el archivo no está asociado con ninguna etiqueta. Se puede especificar un máximo de 10 etiquetas. | |
string | No | La etiqueta del archivo. Cada etiqueta puede tener hasta 12 caracteres de longitud y admite caracteres de la categoría de letras Unicode (incluidas letras en inglés, caracteres chinos y dígitos), guiones bajos (_) y guiones (-). | Introducción al producto | |
| OverWriteFileByOssKey | boolean | No | Especifica si se deben sobrescribir los archivos con la misma OssKey en la categoría. Valor predeterminado: false, lo que significa que los archivos no se sobrescriben. | false |
Elementos de respuesta
Elemento | Tipo | Descripción | Ejemplo |
|---|---|---|---|
object | Esquema de la respuesta | ||
| Code | string | El código de error. | success |
| Data | object | El campo de datos devuelto por la operación. | |
| AddFileResultList | array<object> | La lista de resultados de importación de archivos. | |
object | La lista de resultados de importación de archivos. | ||
| FileId | string | El ID del archivo. Guarde este valor de forma segura, ya que se utilizará para todas las operaciones posteriores de la API relacionadas con este archivo. | file_809f469a59ac449586ec692576xxxxx_102248XXX |
| OssKey | string | El nombre de clave (Key) del archivo importado en el Bucket de OSS. | root/path/this_is_temp_xxxx.pdf |
| Status | string | Estado de importación del archivo. Valores posibles:
Solo los archivos con estado SUCCESS se pueden utilizar para crear o actualizar bases de conocimiento. | SUCCESS |
| Msg | string | Información de error devuelta cuando falla la importación del archivo. | tamaño demasiado grande |
| Message | string | El mensaje de error. | No se puede encontrar la categoría para el parámetro category_id. |
| RequestId | string | El ID de la solicitud. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| Status | string | El código de estado devuelto por la operación. | 200 |
| Success | string | Indica si la llamada se realizó correctamente. Valores válidos:
| true |
Ejemplos
Respuesta exitosa
Formato JSON
{
"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"
}
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.