Alibaba Cloud Model Studio:ListIndexDocuments

Recupera archivos y su información resumida de una base de conocimientos específica.

Descripción de la operación

• Los usuarios de Resource Access Management (RAM) deben obtener primero permisos de API para Model Studio (requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:ListIndexFiles) 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. Utilice el último SDK de Model Studio para invocar esta operación.
• Antes de invocar esta operación, asegúrese de que su base de conocimientos se haya creado y no se haya eliminado (es decir, que el ID de la base de conocimientos IndexId sea válido).
• Esta operación tiene idempotencia.

Limitación de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 15 llamadas por segundo. Si se aplica la limitación, 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 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:ListIndexFiles	list	*Todos los recursos *	None	None

Sintaxis de la solicitud

GET /{WorkspaceId}/index/list_index_documents HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo de la base de conocimientos. Para obtener información sobre cómo conseguir el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.	llm-3z7uw7fwz0vexxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
IndexId	string	Sí	El ID de la base de conocimientos, que es el Data.Id devuelto por la operación CreateIndex.	79c0alxxxx
DocumentStatus	string	No	Filtra la lista de archivos devuelta por estado de importación de archivo. Valores válidos: INSERT_ERROR: Error al importar al índice. RUNNING: Construcción del índice en curso. DELETED: eliminado. FINISH: Construcción del índice exitosa. PARSE_FAILED: Error en el análisis. DOC_PARSING: Análisis en curso. Valor predeterminado: vacío, lo que significa que no hay filtrado por estado de importación de archivo. Valores válidos: INSERT_ERROR : Error en la importación del archivo. RUNNING : Importación de archivo en curso. DELETED : Archivo eliminado. FINISH : Importación de archivo exitosa.	FINISH
DocumentName	string	No	Filtra la lista de archivos devuelta por nombre de archivo (sin la extensión del archivo). Valor predeterminado: vacío, lo que significa que no se filtra por nombre de archivo.	product-overview
EnableNameLike	string	No	Especifica si se debe habilitar la coincidencia difusa para los nombres de archivo. Este parámetro se utiliza junto con el parámetro DocumentName. Valores válidos: true: Realiza coincidencia difusa en la lista de archivos devuelta basada en el nombre del archivo. false: Realiza coincidencia exacta en la lista de archivos devuelta basada en el nombre del archivo. Valor predeterminado: false. Valores válidos: true : habilitado. false : deshabilitado.	false
PageNumber	integer	No	El número de página. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de archivos que se mostrarán por página en una consulta paginada. Sin límite máximo. Valor predeterminado: 10.	10

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
RequestId	string	El ID de la solicitud.	35A267BF-xxxx-54DB-8394-AA3B0742D833
Code	string	El código de estado de error.	InvalidParameter
Message	string	El mensaje de error.	Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.
Success	boolean	Indica si la operación fue exitosa. Valores válidos: true: Exitoso. false: Fallido.	true
Data	object	El campo de datos devuelto por la operación.
Documents	array<object>	La lista de archivos en la base de conocimientos, ordenada por hora de importación del documento en orden descendente (consistente con la consola).
	object	El objeto de archivo.
SourceId	string	Para bases de conocimientos de búsqueda de documentos, este parámetro especifica el ID de categoría, que es el CategoryId devuelto por la operación AddCategory. También puede obtenerlo haciendo clic en el icono de ID junto al nombre de la categoría en la pestaña Files de Application Data. Para bases de conocimientos de consulta de datos o preguntas y respuestas de imágenes, este parámetro especifica el ID de la tabla de datos. Puede obtenerlo haciendo clic en el icono de ID junto al nombre de la tabla de datos en la pestaña Tables de Application Data.	cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
Id	string	El ID del archivo.	doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
Name	string	El nombre del archivo.	product-overview
Size	integer	El tamaño del archivo, en bytes.	996765
DocumentType	string	El tipo de formato de archivo. Valores válidos: pdf, docx, doc, txt, md, pptx, ppt, png, jpg, jpeg, bmp, gif y EXCEL.	pdf
Status	string	El estado de importación del archivo. Valores válidos: INSERT_ERROR: Error en la importación del archivo. RUNNING: Importación de archivo en curso. DELETED: Archivo eliminado. FINISH: Importación de archivo exitosa. Valores válidos: INSERT_ERROR : Error en la importación del archivo. RUNNING : Importación de archivo en curso. DELETED : Archivo eliminado. FINISH : Importación de archivo exitosa.	RUNNING
Code	string	El código de estado de error para la importación del archivo.	110002
Message	string	El mensaje de error para la importación del archivo.	verificar fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] no es válido
GmtModified	integer	La hora en que el archivo se importó a la base de conocimiento, en formato de marca de tiempo UNIX.	1744856423000
IndexId	string	El ID de la base de conocimientos.	pno97txxxx
TotalCount	integer	El número total de resultados devueltos.	2437
PageNumber	integer	El número de página devuelto.	1
PageSize	integer	El número de entradas por página devuelto.	10
Status	string	El código de estado devuelto por la operación.	200

Ejemplos

Respuesta exitosa

Formato JSON

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx",
        "Name": "product-overview",
        "Size": 996765,
        "DocumentType": "pdf",
        "Status": "RUNNING",
        "Code": "110002",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "GmtModified": 1744856423000
      }
    ],
    "IndexId": "pno97txxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

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.