Skip to main content
Conexão de dados (anteriormente dados de aplicativo)

ApplyFileUploadLease

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.

Descrição da operação

  • Os usuários do RAM (subcontas) devem primeiro obter as permissões de API para o Alibaba Cloud Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ApplyFileUploadLease) e entrar em um workspace antes de chamar esta API. As contas da Alibaba Cloud (contas primárias) podem chamar esta API diretamente sem autorização. Recomendamos que você chame esta API usando o SDK do Alibaba Cloud Model Studio mais recente.
  • Esta API não é idempotente.
Limitação de taxa: Esta API está sujeita a limitação de taxa se for chamada com muita frequência. A frequência não deve exceder 10 chamadas por segundo. Se houver limitação, tente novamente mais tarde.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:
  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
  • API: A API que você pode chamar para executar a ação.
  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sfm:ApplyFileUploadLease

none

*All Resource

*

NenhumaNenhuma

Sintaxe da solicitação 

POST /{WorkspaceId}/datacenter/category/{CategoryId} HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

CategoryId

string

Sim

Ao enviar arquivos para a criação de uma base de conhecimento:

  • Este campo representa o ID da categoria à qual o arquivo enviado pertence, que é o CategoryId retornado pela API AddCategory. Você também pode obtê-lo clicando no ícone de ID ao lado do nome da categoria em Dados do aplicativo - aba Arquivos. Você pode passar default aqui para usar a "Categoria padrão" criada pelo sistema.

Para criar uma nova tabela de dados e enviar dados, use o console do Alibaba Cloud Model Studio. Isso não é suportado através da API.

  • Você pode simplesmente passar default aqui. O sistema criará ou corresponderá automaticamente a uma categoria padrão. As APIs de categoria de arquivo dinâmico e as páginas de gerenciamento do console estarão disponíveis no futuro.

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

WorkspaceId

string

Sim

O ID do workspace ao qual o arquivo enviado pertence. Para obter informações sobre como obter o ID do workspace, consulte Como usar workspaces.

llm-3z7uw7fwz0vexxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

FileName

string

Sim

Ao enviar arquivos para a criação de uma base de conhecimento:

  • Este campo representa o nome do arquivo enviado. O nome do arquivo deve incluir a extensão do formato do arquivo. Formatos suportados:

    • Documentos (menos de 150 MB): doc, docx, wps, ppt, pptx, xls, xlsx, md, txt, pdf, epub, mobi.

    • Planilhas (recomendado até 10 MB e 100.000 linhas): xls, xlsx.

    • Texto simples (recomendado não exceder 10 MB): md, txt.

    • Imagens (menos de 20 MB, lado menor > 15 px, lado maior < 8192 px, proporção < 50): png, jpg, jpeg, bmp, gif.

    • Áudio: aac, amr, flac, flv, m4a, mp3, mpeg, ogg, opus, wav, webm, wma.

    • Vídeo: mp4, mkv, avi, mov, wmv.

  • O nome do arquivo deve ter de 4 a 128 caracteres. Para outros limites, consulte Cotas e limites da base de conhecimento.

Para criar uma nova tabela de dados e enviar dados, use o console do Alibaba Cloud Model Studio. Isso não é suportado através da API.

XXXX产品清单.pdf

Md5

string

Sim

O valor MD5 do arquivo enviado. O servidor verificará este campo (atualmente não habilitado). Preencha com o valor correto.

19657c391f6c70bcea63c154d8606bb3

SizeInBytes

string

Sim

O tamanho do arquivo enviado em bytes. O servidor verificará este campo (atualmente não habilitado). Preencha com o valor correto. Valores válidos: 1 B a 100 MB.

1000

CategoryType

string

Não

O tipo de categoria. Se este parâmetro não for especificado, o valor padrão é UNSTRUCTURED. Valores válidos:

UNSTRUCTURED: categoria para a criação de cenários de base de conhecimento.

SESSION_FILE: envia arquivos para interações conversacionais de aplicativos de agente.

Para criar uma nova tabela de dados e enviar dados, use o console do Alibaba Cloud Model Studio. Isso não é suportado através da API.

UNSTRUCTURED

UseInternalEndpoint

boolean

Não

Se você habilitou o armazenamento seguro do Alibaba Cloud Model Studio e precisa gerar uma URL de concessão que seja acessível apenas pela rede interna da Alibaba Cloud na mesma região, você pode definir este parâmetro como true para melhorar a segurança. Se este parâmetro não for especificado, o valor padrão é false, o que gera uma URL de concessão acessível publicamente.

Se você não habilitou o armazenamento seguro do Alibaba Cloud Model Studio, ou não tem certeza se está usando, não defina este parâmetro como true (o upload falhará).

false

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

Code

string

O código de erro.

DataCenter.FileTooLarge

Data

object

Os dados retornados.

FileUploadLeaseId

string

O ID exclusivo da concessão. Você precisa usar este parâmetro ao chamar a API AddFile.

1e6a159107384782be5e45ac4759b247.1719325231035

Param

object

Os parâmetros de solicitação HTTP para o upload do arquivo.

Headers

any

Key-value pairs that need to be included in the header. Both keys and values are strings.

The returned Content-Type may be empty. You can upload the file with the empty value.

"X-bailian-extra":"MTAwNTQyNjQ5NTE2OTE3OA==", "Content-Type":"application/pdf"

Method

string

The HTTP method. Valid values:

  • PUT

  • POST

PUT

Url

string

The upload URL of the file.

This URL is a pre-signed URL. FormData upload is not supported. You must upload the file in binary mode.

https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=YOUR_ACCESS_KEY_ID&Signature=YOUR_SIGNATURE

Type

string

O método de upload do arquivo. Valores válidos:

  • OSS.PreSignedURL

  • HTTP

HTTP

Message

string

A mensagem de erro.

User not authorized to operate on the specified resource

RequestId

string

O ID da solicitação.

778C0B3B-xxxx-5FC1-A947-36EDD13606AB

Status

string

O código de status retornado.

200

Success

boolean

Indica se a chamada da API foi bem-sucedida. Valores válidos:

  • true: A chamada foi bem-sucedida.

  • false: A chamada falhou.

true

Exemplos

Resposta de sucesso JSON formato 
{
  "Code": "DataCenter.FileTooLarge",
  "Data": {
    "FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
    "Param": {
      "Headers": "\"X-bailian-extra\":\"MTAwNTQyNjQ5NTE2OTE3OA==\",\n\"Content-Type\":\"application/pdf\"",
      "Method": "PUT",
      "Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=YOUR_ACCESS_KEY_ID&Signature=YOUR_SIGNATURE"
    },
    "Type": "HTTP"
  },
  "Message": "User not authorized to operate on the specified resource",
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Status": "200",
  "Success": true
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.
Chamada de Aplicação
Componentes do aplicativo
Assistant API (Deprecated)
Mais
ApplyFileUploadLease - Alibaba Cloud Model Studio