Estándares de API y SDK preconfigurados multilingües
La OpenAPI de este producto (bailian/2023-12-29) utiliza el estilo de firma ROA. Hemos encapsulado SDKs para lenguajes de programación comunes para desarrolladores. Los desarrolladores pueden descargar el SDK para llamar directamente a la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, puede utilizar el mecanismo de firma para la integración mediante autofirma. Dado que los detalles de la autofirma son muy complejos, puede tardar alrededor de 5 días hábiles. Por lo tanto, le recomendamos unirse a nuestro grupo de servicio de DingTalk (147535001692) y realizar la integración de firmas bajo la guía de expertos.
Antes de utilizar la API, debe preparar su cuenta de identidad y clave de acceso (AccessKey) para acceder eficazmente a la API a través de herramientas cliente (como SDK y CLI). Para obtener más detalles, consulte Obtener una AccessKey.
Escenarios de firma personalizada
Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, le recomendamos consultar primero con nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.
Preparación de cuenta y seguridad
Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Una vez que una AccessKey se ve comprometida, todos los recursos asociados estarán en riesgo de acceso no autorizado. Para garantizar la seguridad, se recomienda crear un usuario RAM con solo permisos de acceso a la API y configurar su AccessKey, mientras se configuran las políticas de RAM basándose en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud solo en escenarios específicos donde se requieran explícitamente permisos de cuenta de Alibaba Cloud.
Conexión de datos (anteriormente datos de aplicación)
API | Título | Descripción |
|---|---|---|
| AddCategory | Agregar categoría | Crea una categoría en un espacio de trabajo especificado para clasificar y administrar archivos. Cada espacio de trabajo admite un máximo de 500 categorías. |
| ListCategory | Lista de categorías | Recupera los detalles de una o más categorías en un espacio de trabajo especificado. |
| DeleteCategory | Eliminar una categoría | Elimina permanentemente una categoría especificada. |
| ApplyFileUploadLease | Solicitar una concesión de carga de archivo | Solicita una concesión de carga para subir archivos de base de conocimiento o archivos para interacciones conversacionales de aplicaciones de agente. |
| AddFile | Agregar archivo | Importa un archivo desde el almacenamiento temporal de Alibaba Cloud Model Studio a una conexión de datos de Alibaba Cloud Model Studio (anteriormente conocida como datos de aplicación). |
| AddFilesFromAuthorizedOss | Importar archivos desde un bucket de OSS autorizado | Importa archivos desde un bucket de OSS autorizado a los datos de aplicación de Alibaba Cloud Model Studio. |
| ListFile | Lista de archivos | Recupera los detalles de uno o más documentos en una categoría especificada. |
| DescribeFile | Consultar estado del archivo | Consulta la información básica de un archivo en los datos de aplicación, incluido el nombre del archivo, el tipo y el estado. |
| UpdateFileTag | Actualizar etiqueta de archivo | Actualiza las etiquetas de un archivo especificado. |
| BatchUpdateFileTag | BatchUpdateFileTag | Esta operación actualiza las etiquetas de documentos en una conexión de datos por lotes. |
| DeleteFile | Eliminar archivo | Elimina permanentemente un archivo especificado de los datos de aplicación. No se admite la eliminación de tablas de datos mediante API. Para obtener más detalles, consulte la Guía de API a continuación. |
| DeleteFiles | Eliminar archivos en lote | Eliminar archivos en lote |
| GetParseSettings | GetParseSettings | Consulta la configuración de análisis de datos en una categoría especificada. |
| GetAvailableParserTypes | GetAvailableParserTypes | Enumera todos los tipos de analizadores admitidos según el tipo de archivo de entrada (extensión de archivo). |
| ChangeParseSetting | Modificar configuración de análisis de categoría | Configura el método de análisis para tipos de archivos específicos. Por ejemplo, especifica el análisis de documentos de modelo grande para archivos .pdf o el análisis VL de Qwen para archivos .jpg. |
| AddTable | AddTable | Agrega una tabla para el conector de datos de tabla. |
| UpdateTableFromAuthorizedOss | UpdateTableFromAuthorizedOss | Actualiza una tabla en un conector de datos de Alibaba Cloud Model Studio utilizando un archivo de un bucket de OSS autorizado. |
| AddConnector | AddConnector | Crea un conector. Esta API actualmente solo admite conectores de archivos. |
| GetConnector | GetConnector | Recupera detalles sobre un conector. Esta operación actualmente solo admite conectores de archivos. |
| UpdateConnector | UpdateConnector | Actualiza un conector. |
Base de conocimiento
API | Título | Descripción |
|---|---|---|
| CreateIndex | Crear una base de conocimiento | Crea una base de conocimiento, ya sea una base de conocimiento no estructurada basada en documentos o audio/video, o una base de conocimiento estructurada para consultas de datos o preguntas y respuestas basadas en imágenes. |
| GetIndexJobStatus | Consultar estado del trabajo de base de conocimiento | Consulta el estado actual de una tarea de creación de base de conocimiento especificada o una tarea de adición de documentos a la base de conocimiento. |
| SubmitIndexJob | Enviar una tarea de creación de base de conocimiento | Envía una tarea CreateIndex especificada para completar la creación de la base de conocimiento. |
| SubmitIndexAddDocumentsJob | Enviar un trabajo de adición a base de conocimiento | Agrega archivos analizados a la base de conocimiento especificada. |
| Retrieve | Retrieve | Recupera información de una base de conocimiento especificada. |
| ListIndexDocuments | Consultar archivos en una base de conocimiento | Recupera archivos y su información resumida de una base de conocimiento especificada. |
| ListIndexFileDetails | Consultar detalles de archivos en una base de conocimiento | Recupera los archivos en una base de conocimiento especificada junto con sus detalles. |
| DeleteIndexDocument | Eliminar archivos de una base de conocimiento | Elimina permanentemente archivos de una base de conocimiento especificada. |
| ListIndices | Listar bases de conocimiento | Recupera la lista de bases de conocimiento en un espacio de trabajo especificado. |
| DeleteIndex | Eliminar una base de conocimiento | Elimina permanentemente una base de conocimiento especificada. |
| ListChunks | Consultar lista de fragmentos bajo un índice | Consulta la lista y la información de los fragmentos de texto. |
| UpdateChunk | Actualizar un fragmento | Modifica el contenido y el título de un fragmento de texto especificado en una base de conocimiento, y especifica si el fragmento participa en la recuperación de la base de conocimiento. |
| DeleteChunk | Eliminar fragmentos | Elimina fragmentos de texto especificados de una base de conocimiento. Los fragmentos de texto eliminados no se pueden recuperar ni recordar. |
Ingeniería de prompts
API | Título | Descripción |
|---|---|---|
| CreatePromptTemplate | Crear una plantilla de prompt | Crear una plantilla de prompt. |
| DeletePromptTemplate | DeletePromptTemplate | Elimina una plantilla de prompt basada en el ID de la plantilla. |
Otros
API | Título | Descripción |
|---|---|---|
| CreateMemory | Crear una memoria a largo plazo | Crea una memoria a largo plazo. |
| GetMemory | Recuperar memoria a largo plazo | Recupera la descripción de una memoria a largo plazo especificada. |
| UpdateMemory | Actualizar memoria a largo plazo | Actualiza la descripción de una memoria a largo plazo especificada. |
| DeleteMemory | Eliminar memoria a largo plazo | Elimina permanentemente una memoria a largo plazo especificada. |
| ListMemories | Listar memorias a largo plazo | Recupera los detalles de una o más entidades de memoria a largo plazo en un espacio de trabajo especificado. |
| CreateMemoryNode | Crear un nodo de memoria | Crea un nodo de memoria. |
| GetMemoryNode | Recuperar un fragmento de memoria | Recupera un fragmento de memoria. |
| UpdateMemoryNode | Actualizar un fragmento de memoria | Actualiza un fragmento de memoria. |
| DeleteMemoryNode | Eliminar un fragmento de memoria | Elimina un fragmento de memoria. |
| ListMemoryNodes | Recuperar lista de nodos de memoria | Recupera una lista de nodos de memoria. |
| ApplyTempStorageLease | ApplyTempStorageLease | Esta interfaz está destinada únicamente a la implementación pro-code; actualmente no se admiten otros escenarios. Se utiliza para solicitar una concesión de carga de archivos temporal. Después de obtener la concesión, debe cargar el archivo manualmente. |
| AddChunk | Agregar un fragmento | Agrega fragmentos a una base de conocimiento de búsqueda de documentos (documento), consulta de datos (tabla) o preguntas y respuestas de imágenes (imagen). |
| GetPromptTemplate | GetPromptTemplate | Obtiene una plantilla de prompt basada en el ID de la plantilla. |
| ListPromptTemplates | ListPromptTemplates | Obtiene una lista de plantillas de prompts. |
| UpdatePromptTemplate | UpdatePromptTemplate | Actualiza una plantilla de prompt basada en el ID de la plantilla. |