Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (bailian/2023-12-29) utiliza o estilo de assinatura ROA. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Conexão de dados (anteriormente dados de aplicativo)
API | Título | Descrição |
|---|---|---|
| AddCategory | Adicionar categoria. | Cria uma categoria em um workspace especificado para classificar e gerenciar arquivos. Cada workspace suporta no máximo 500 categorias. |
| ListCategory | Lista de categorias. | Obtém os detalhes de uma ou mais categorias em um workspace especificado. |
| DeleteCategory | Excluir uma categoria. | Exclui permanentemente uma categoria especificada. |
| ApplyFileUploadLease | Solicitação de concessão de upload de arquivo. | Solicita uma concessão de upload para o envio de arquivos da base de conhecimento ou arquivos para interações conversacionais de aplicativos de agente. |
| AddFile | Add file | Importa um arquivo do armazenamento temporário do Alibaba Cloud Model Studio para uma conexão de dados do Alibaba Cloud Model Studio (anteriormente conhecida como dados de aplicativo). |
| AddFilesFromAuthorizedOss | Importar arquivos de um bucket OSS autorizado. | Importa arquivos de um bucket OSS autorizado para os dados de aplicativos do Alibaba Cloud Model Studio. |
| ListFile | File list | Retrieves the details of one or more documents in a specified category. |
| DescribeFile | Query file status | Queries the basic information of a file in application data, including the file name, type, and status. |
| UpdateFileTag | Atualizar tags de arquivo. | Atualiza as tags de um arquivo especificado. |
| BatchUpdateFileTag | BatchUpdateFileTag. | Atualiza as tags de documentos em uma conexão de dados em lotes. |
| DeleteFile | Excluir arquivo. | Exclui permanentemente um arquivo especificado dos dados da aplicação. A exclusão de tabelas de dados via API não é suportada. Para obter mais detalhes, consulte o Guia da API abaixo. |
| DeleteFiles | Exclusão de arquivos em lote. | Exclui arquivos em lote. |
| GetParseSettings | GetParseSettings. | Consulta as configurações de análise de dados em uma categoria especificada. |
| GetAvailableParserTypes | GetAvailableParserTypes. | Lista todos os tipos de parser suportados com base no tipo de arquivo de entrada (extensão do arquivo). |
| ChangeParseSetting | Modificar configurações de análise de categoria. | Configura o método de análise para tipos de arquivo específicos. Por exemplo, especifica a análise de documentos por modelo grande para arquivos .pdf ou a análise Qwen VL para arquivos .jpg. |
| AddTable | AddTable | Add a table for the table data connector. |
| UpdateTableFromAuthorizedOss | UpdateTableFromAuthorizedOss. | Atualiza uma tabela em um conector de dados do Alibaba Cloud Model Studio usando um arquivo de um bucket OSS autorizado. |
| AddConnector | AddConnector. | Cria um conector. Atualmente, esta API suporta apenas conectores de arquivos. |
| GetConnector | GetConnector. | Obtém detalhes sobre um conector. Esta operação atualmente suporta apenas conectores de arquivo. |
| UpdateConnector | UpdateConnector. | Atualiza um conector. |
Base de conhecimento
API | Título | Descrição |
|---|---|---|
| CreateIndex | Criar uma base de conhecimento. | Cria uma base de conhecimento, seja uma base de conhecimento não estruturada baseada em documentos ou áudio/vídeo, ou uma base de conhecimento estruturada para consultas de dados ou perguntas e respostas baseadas em imagens. |
| GetIndexJobStatus | Consulta do status do job da base de conhecimento. | Consulta o status atual de uma tarefa de criação de base de conhecimento ou de uma tarefa de adição de documentos à base de conhecimento especificada. |
| SubmitIndexJob | Submeter uma tarefa de criação de base de conhecimento. | Submete uma tarefa CreateIndex especificada para concluir a criação da base de conhecimento. |
| SubmitIndexAddDocumentsJob | Envio de um trabalho de adição à base de conhecimento. | Adiciona arquivos analisados à base de conhecimento especificada. |
| Retrieve | Retrieve | Obtém informações de uma base de conhecimento especificada. |
| ListIndexDocuments | Consulta de arquivos em uma base de conhecimento. | Obtém arquivos e suas informações resumidas de uma base de conhecimento especificada. |
| ListIndexFileDetails | Consulta detalhes de arquivos em uma base de conhecimento. | Obtém os arquivos em uma base de conhecimento especificada, juntamente com seus detalhes. |
| DeleteIndexDocument | Exclusão de arquivos de uma base de conhecimento. | Exclui permanentemente arquivos de uma base de conhecimento especificada. |
| ListIndices | Listar bases de conhecimento. | Obtém a lista de bases de conhecimento em um workspace especificado. |
| DeleteIndex | Excluir uma base de conhecimento. | Exclui permanentemente uma base de conhecimento especificada. |
| ListChunks | Consultar lista de chunks em um índice. | Consulta a lista e as informações de chunks de texto. |
| UpdateChunk | Atualizar um chunk. | Modifica o conteúdo e o título de um chunk de texto especificado em uma knowledge base e especifica se o chunk participa da recuperação da knowledge base. |
| DeleteChunk | Excluir trechos. | Exclui trechos de texto especificados de uma base de conhecimento. Os trechos de texto excluídos não podem ser recuperados ou evocados. |
Engenharia de prompts
API | Título | Descrição |
|---|---|---|
| CreatePromptTemplate | Criar um modelo de prompt. | Cria um modelo de prompt. |
| DeletePromptTemplate | DeletePromptTemplate. | Exclui um modelo de prompt com base no ID do modelo. |
Outros
API | Título | Descrição |
|---|---|---|
| CreateMemory | Criar uma memória de longo prazo. | Cria uma memória de longo prazo. |
| GetMemory | Obter memória de longo prazo. | Obtém a descrição de uma memória de longo prazo especificada. |
| UpdateMemory | Atualizar memória de longo prazo. | Atualiza a descrição de uma memória de longo prazo especificada. |
| DeleteMemory | Excluir memória de longo prazo. | Exclui permanentemente uma memória de longo prazo especificada. |
| ListMemories | Listar memórias de longo prazo. | Obtém os detalhes de uma ou mais entidades de memória de longo prazo em um workspace especificado. |
| CreateMemoryNode | Criar um nó de memória. | Cria um nó de memória. |
| GetMemoryNode | Obter um fragmento de memória. | Obtém um fragmento de memória. |
| UpdateMemoryNode | Atualizar um fragmento de memória. | Atualiza um fragmento de memória. |
| DeleteMemoryNode | Exclusão de um fragmento de memória. | Exclui um fragmento de memória. |
| ListMemoryNodes | Lista de nós de memória. | Obtém uma lista de nós de memória. |
| ApplyTempStorageLease | ApplyTempStorageLease. | Esta interface é destinada apenas para implantação pro-code; outros cenários não são suportados no momento. É usada para solicitar uma concessão temporária de upload de arquivo. Após obter a concessão, você deve fazer o upload do arquivo manualmente. |
Others
API | Título | Descrição |
|---|---|---|
| AddChunk | Add a chunk. | Adiciona chunks a uma base de conhecimento de busca de documentos (document), consulta de dados (table) ou perguntas e respostas por imagem (image). |
| GetPromptTemplate | GetPromptTemplate. | Obtém um modelo de prompt com base no ID do modelo. |
| ListPromptTemplates | ListPromptTemplates. | Obtém uma lista de modelos de prompt. |
| UpdatePromptTemplate | UpdatePromptTemplate. | Atualiza um modelo de prompt com base no ID do modelo. |