Consultar fragmentos de base de conocimiento mediante la API ListChunks - Model Studio - Alibaba Cloud_Alibaba Cloud Model Studio(Model Studio) - Alibaba Cloud Model Studio

Consulta la lista e información de los fragmentos de texto.

Descripción de la operación

Para bases de conocimiento de búsqueda de documentos, esta operación consulta todos los fragmentos de un archivo especificado. Para bases de conocimiento de consulta de datos o preguntas y respuestas sobre imágenes, esta operación recupera información sobre todos los fragmentos de texto.
Los usuarios de Resource Access Management (RAM) deben obtener primero permisos de API para Model Studio (requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:ChunkList), 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.

Límite de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 10 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:ChunkList	list	Todos los recursos ``	None	None

Acción

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sfm:ChunkList

list

*Todos los recursos

*

None

Sintaxis de la solicitud

POST /{WorkspaceId}/index/list_chunks 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-3z7uw7fwz0vxxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
body	object	No	El cuerpo de los parámetros de la solicitud.
Fields	array	No	Una matriz de nombres de campos utilizada para filtrar campos no privados (aquellos sin prefijo de guion bajo _) en el campo Metadata devuelto por esta operación. De forma predeterminada, Fields está vacío y se devuelven todos los campos no privados en Metadata. Para devolver solo campos no privados específicos en Metadata, como title, pase title en este parámetro. Valor predeterminado: vacío.
	string	No	El nombre del campo.	nombre
Filed	string	No	El campo de ID de archivo en el SDK heredado de Model Studio. El uso y el valor predeterminado son idénticos a los del campo `FileId`. Si utiliza las siguientes versiones (o posteriores) del SDK de Model Studio, utilice el campo `FileId` en su lugar. Si utiliza el SDK de Model Studio SWIFT, continúe utilizando este campo. Java (async): 1.0.18 Java: 1.10.2 TypeScript: 1.10.2 Go: 1.10.2 PHP: 1.10.2 Python: 1.10.2 C#: 1.10.2 C++: 1.10.17 Cómo verificar la versión del SDK de Model Studio: Visite el centro del SDK de Model Studio, haga clic en "Install" en el panel de navegación izquierdo, establezca la versión de la API en "2023-12-29", seleccione su lenguaje de programación y luego haga clic en "History Versions" para ver la versión.	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx
FileId	string	No	El ID del archivo, que es el `FileId` devuelto por la operación AddFile. Este campo no es obligatorio para bases de conocimiento de consulta de datos o preguntas y respuestas sobre imágenes. Este campo es obligatorio para bases de conocimiento de búsqueda de documentos. También puede obtener el ID del archivo haciendo clic en el icono de ID junto al nombre del archivo en la pestaña Archivos de Datos de la aplicación. Puede utilizar el ID del archivo para filtrar los fragmentos devueltos. Valor predeterminado: vacío. .	file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx
IndexId	string	Sí	El ID de la base de conocimientos, que es el `Data.Id` devuelto por la operación CreateIndex.	otoru9xxxx
PageNum	integer	No	El número de página a consultar. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de fragmentos de texto que se mostrarán por página en una consulta paginada. Valor máximo: 100. Valor predeterminado: 10.	10

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Code	string	El código de estado de error.	Index.InvalidParameter
Data	object	Los datos comerciales devueltos por la operación.
Nodes	array<object>	La lista de fragmentos de texto.
	object	El objeto de fragmento de texto.
Metadatos	any	El mapa de metadatos del fragmento.	{ "file_path": "https://bailian-*", "parent": "Alibaba Cloud Model Studio is a one-stop platform for large model development and application building. Both developers and business users can deeply participate in the design and construction of large model applications. Through simple UI operations, you can develop a large model application in 5 minutes or train a custom model in a few hours, freeing you to focus on application innovation.", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e", "content": "Alibaba Cloud Model Studio is a one-stop platform for large model development and application building. Both developers and business users can deeply participate in the design and construction of large model applications. Through simple UI operations, you can develop a large model application in 5 minutes or train a custom model in a few hours, freeing you to focus on application innovation.", "_rc_score": 0, "workspace_id": "llm-zna", "hier_title": "", "doc_name": "What is Alibaba Cloud Model Studio", "pipeline_id": "j6b", "_id": "llm-zna5*" }
Score	number	La puntuación de similitud del fragmento.	0
Texto	string	El texto del fragmento.	Alibaba Cloud Model Studio es una plataforma integral para el desarrollo de modelos grandes y la creación de aplicaciones. Tanto los desarrolladores como los usuarios empresariales pueden participar profundamente en el diseño y la construcción de aplicaciones de modelos grandes. Mediante operaciones sencillas en la interfaz de usuario, puede desarrollar una aplicación de modelo grande en 5 minutos o entrenar un modelo personalizado en unas pocas horas, lo que le permite concentrarse en la innovación de la aplicación.
Total	integer	El número total de resultados devueltos.	1
Message	string	El mensaje de error.	Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.
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": "Index.InvalidParameter",
  "Data": {
    "Nodes": [
      {
        "Metadata": "{\n  \"file_path\": \"https://bailian-***\",\n  \"parent\": \"Alibaba Cloud Model Studio is a one-stop platform for large model development and application building. Both developers and business users can deeply participate in the design and construction of large model applications. Through simple UI operations, you can develop a large model application in 5 minutes or train a custom model in a few hours, freeing you to focus on application innovation.\",\n  \"is_displayed_chunk_content\": \"true\",\n  \"image_url\": [],\n  \"nid\": \"83***\",\n  \"source\": \"0\",\n  \"_score\": 0,\n  \"title\": \"\",\n  \"doc_id\": \"file_24e***\",\n  \"content\": \"Alibaba Cloud Model Studio is a one-stop platform for large model development and application building. Both developers and business users can deeply participate in the design and construction of large model applications. Through simple UI operations, you can develop a large model application in 5 minutes or train a custom model in a few hours, freeing you to focus on application innovation.\",\n  \"_rc_score\": 0,\n  \"workspace_id\": \"llm-zna***\",\n  \"hier_title\": \"\",\n  \"doc_name\": \"什么是阿里云百炼\",\n  \"pipeline_id\": \"j6b***\",\n  \"_id\": \"llm-zna5***\"\n}",
        "Score": 0,
        "Text": "Alibaba Cloud Model Studio is a one-stop platform for large model development and application building. Both developers and business users can deeply participate in the design and construction of large model applications. Through simple UI operations, you can develop a large model application in 5 minutes or train a custom model in a few hours, freeing you to focus on application innovation."
      }
    ],
    "Total": 1
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "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.