Alibaba Cloud Model Studio:ListFile

Recupera los detalles de uno o más documentos en una categoría especificada.

Descripción de la operación

• Los usuarios de Resource Access Management (RAM) deben obtener primero permisos de API para Alibaba Cloud Model Studio (requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:ListFile), 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. Invoque esta operación utilizando el último SDK de Alibaba Cloud Model Studio.
• Para la paginación en la primera página, solo establezca MaxResults para limitar el número de entradas devueltas. El NextToken en la respuesta sirve como credencial para consultar páginas subsiguientes. Al consultar páginas subsiguientes, establezca el parámetro NextToken en el valor NextToken obtenido de la respuesta anterior (si NextToken está vacío, se han devuelto todos los resultados y no se necesitan más solicitudes), y establezca MaxResults para limitar el número de entradas devueltas.
• Esta operación es idempotente.

Límite de tasa: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 5 llamadas por segundo. Si se limita la tasa, reinténtelo 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.

Prueba

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 Action de 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 Resource de la política.
  • Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento Resource de la política.

• 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:ListFile	list	*Todos los recursos *	None	None

Sintaxis de la solicitud

GET /{WorkspaceId}/datacenter/files HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo al que pertenece la categoría. Para obtener información sobre cómo obtener el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.	llm-3shx2gu255oqxxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
CategoryId	string	Sí	El ID de la categoría, que es el CategoryId devuelto por la operación AddCategory. También puede obtenerlo en la pestaña Datos de la aplicación - Archivos haciendo clic en el icono de ID junto al nombre de la categoría. .	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
NextToken	string	No	El token de paginación. Establézcalo en el valor NextToken devuelto por la llamada anterior a la API.	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	No	El número de entradas por página para la paginación. Valores válidos: de 1 a 200. Valor predeterminado: Si no se establece ningún valor o el valor es menor que 1, el valor predeterminado es 20. Si el valor se establece en mayor que 200, el valor predeterminado es 200.	20
FileName	string	No	El nombre del archivo (sin extensión). Solo se admite coincidencia exacta. No se admite búsqueda difusa.	product-overview
FileIds	array	No	La lista de IDs de archivo a consultar. Se pueden consultar un máximo de 20 archivos a la vez.
	string	No	El ID del archivo.	file_xxxx

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.
FileList	array<object>	La lista de archivos en la categoría.
	object	El objeto de archivo.
CategoryId	string	El ID de la categoría a la que pertenece el archivo.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx
CreateTime	string	La marca de tiempo cuando el archivo se agregó a Alibaba Cloud Model Studio. Formato: yyyy-MM-dd HH:mm:ss. Zona horaria: UTC+8.	2024-09-09 11:03:35
FileId	string	El ID del archivo, que es el FileId devuelto por la operación AddFile. También puede obtenerlo en la página Datos de la aplicación haciendo clic en el icono junto al nombre del archivo.	file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx
FileName	string	El nombre del archivo.	product-overview.pdf
FileType	string	El tipo de formato de archivo. Valores válidos: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp y gif.	docx
Parser	string	El analizador de documentos. Valores válidos: DASHSCOPE_DOCMIND: Análisis inteligente de documentos de Alibaba Cloud.	DASHSCOPE_DOCMIND
SizeInBytes	integer	El tamaño del archivo en bytes.	512
Status	string	El estado de análisis del archivo. Valores válidos: INIT: Estado de inicialización, esperando ser programado. PARSING: Análisis en curso. PARSE_SUCCESS: Análisis completado. PARSE_FAILED: Error de análisis.	PARSE_SUCCESS
ParseErrorMessage	string		Mensaje de error
Etiquetas	array	La lista de etiquetas asociadas con el archivo. Un documento puede estar asociado con múltiples etiquetas.
	string	La etiqueta del archivo.	tag-A
HasNext	boolean	Indica si hay una página siguiente de datos de categoría que coincida con las condiciones de consulta. Valores válidos: true: Sí. false: No.	true
MaxResults	integer	El número de entradas por página para la paginación.	20
NextToken	string	El token de paginación devuelto por esta llamada.	4jzbJk9J6lNeuXD9hP0viA==
TotalCount	integer	El número total de entradas en los resultados devueltos.	48
Message	string	El mensaje de error.	Se activó la limitación de solicitudes.
RequestId	string	El ID de la solicitud.	8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1
Status	string	El código de estado devuelto por la operación.	200
Success	boolean	Indica si la operación fue exitosa. Valores válidos: true: Exitoso. false: Fallido.	true

Ejemplos

Respuesta exitosa

Formato JSON

{
  "Code": "success",
  "Data": {
    "FileList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx",
        "CreateTime": "2024-09-09 11:03:35",
        "FileId": "file_5ff599b3455a45db8c41b0054b361518_xxxxxxxx",
        "FileName": "product-overview.pdf",
        "FileType": "docx",
        "Parser": "DASHSCOPE_DOCMIND",
        "SizeInBytes": 512,
        "Status": "PARSE_SUCCESS",
        "ParseErrorMessage": "Error Message",
        "Tags": [
          "tag-A"
        ]
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "4jzbJk9J6lNeuXD9hP0viA==",
    "TotalCount": 48
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "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.