Todos os produtos
Search
Central de documentação

Alibaba Cloud Model Studio:AddFilesFromAuthorizedOss

Última atualização: Sep 02, 2026

Importa arquivos de um bucket OSS autorizado para os dados de aplicativos do Alibaba Cloud Model Studio.

Descrição da operação

  • Certifique-se de que o bucket OSS pertença à mesma conta da Alibaba Cloud que o Model Studio e que a autorização tenha sido concluída conforme descrito em Instruções de configuração para importação de dados do OSS.

    • Os tipos de armazenamento de bucket suportados não incluem Archive, Cold Archive ou Deep Cold Archive. Buckets com criptografia de conteúdo ativada são suportados. Buckets com acesso de leitura/gravação pública, leitura pública ou privado são suportados.
    • Para usar um bucket com proteção contra hotlink baseada em Referer ativada, adicione o nome de domínio *.console.alibabacloud.com à lista de permissões de Referer, conforme descrito em Permitir acesso apenas de sites confiáveis.
  • Usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Model Studio (a permissão AliyunBailianDataFullAccess é obrigatória, que inclui a permissão sfm:AddFilesFromAuthorizedOss) e ingressar em um workspace antes de invocar esta operação. Contas da Alibaba Cloud podem invocar esta operação diretamente sem autorização. Invoque esta operação usando a versão mais recente do SDK do Model Studio.

  • Esta operação não possui idempotência.

Limite de taxa: Esta operação é limitada se chamada com muita frequência. Não exceda 5 chamadas por segundo. Se for limitada, 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:AddFilesFromAuthorizedOss

create

*全部资源

*

NenhumaNenhuma

Sintaxe da solicitação

POST /{WorkspaceId}/datacenter/file/fromoss HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

WorkspaceId

string

Sim

O ID do workspace. Os arquivos são importados para este workspace. Para mais informações sobre como obter o ID do workspace, consulte Como usar um workspace.

llm-3z7uw7fwz0vxxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

CategoryId

string

Sim

O ID da categoria para a qual os arquivos são importados. Este é o CategoryId retornado pela operação AddCategory. Você também pode obter o ID da categoria clicando no ícone de ID ao lado do nome da categoria na aba Dados de Aplicativos - Arquivos. Você pode passar default para usar a categoria padrão criada pelo sistema.

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

CategoryType

string

Sim

O tipo de categoria. Opcional. Valor padrão: UNSTRUCTURED. Valores válidos:

  • UNSTRUCTURED: categoria para cenários de construção de base de conhecimento.

Valores válidos:

  • UNSTRUCTURED :

    UNSTRUCTURED.

UNSTRUCTURED

OssRegionId

string

Sim

O ID da região do bucket OSS. Para mais informações, consulte Regiões e endpoints do OSS.

cn-beijing

OssBucketName

string

Sim

O nome do bucket OSS. Para mais informações, consulte Buckets.

bucketNamexxxxx

FileDetails

array<object>

Sim

A lista de arquivos a serem importados. Um máximo de 10 arquivos pode ser carregado por vez.

Um máximo de 10 arquivos pode ser carregado por vez.

array<object>

Sim

O objeto de arquivo.

FileName

string

Sim

O nome do arquivo a ser importado. O nome do arquivo deve incluir a extensão do formato de arquivo.

  • Formatos suportados: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp e gif.

  • O nome do arquivo deve ter entre 4 e 128 caracteres.

  • Para requisitos e limites de upload de arquivos, consulte Cotas e limites da base de conhecimento.

Se o nome do arquivo importado for igual ao de um arquivo existente na base de conhecimento, a operação ainda retornará um Status de SUCCESS, mas o arquivo não será realmente importado. O arquivo existente com o mesmo nome permanece inalterado. Certifique-se de que cada nome de arquivo importado seja único.

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

this_is_temp_xxxx.pdf

OssKey

string

Sim

A chave do arquivo no bucket OSS. Para mais informações, consulte Convenções de nomenclatura de objetos.

root/path/this_is_temp_xxxx.pdf

Parser

string

Não

O tipo de parser. Valores válidos:

  • DOCMIND: análise inteligente de documentos.

  • DOCMIND_DIGITAL: análise de documentos eletrônicos.

  • DOCMIND_LLM_VERSION: análise de documentos baseada em LLM.

  • DASH_QWEN_VL_PARSER: análise Qwen VL.

  • DOCMIND_LLM_VERSION_MEDIA: análise de áudio e vídeo.

  • AUTO_SELECT: seleção automática de parser.

O arquivo carregado é analisado usando o parser especificado. Se você definir este parâmetro como AUTO_SELECT, o parser configurado para a categoria será usado.

AUTO_SELECT

ParserConfig

object

Não

A configuração do parser. Este parâmetro é necessário apenas quando o tipo de parser estiver definido como análise Qwen VL.

ModelName

string

Não

O nome do modelo.

qwen-vl-max

ModelPrompt

string

Não

O prompt usado ao chamar a análise Qwen VL.

#角色 你是一个专业的图片内容标注人员,擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片,详细描述图片中的内容。

Tags

array

Não

A lista de tags associadas ao arquivo. Valor padrão: vazio, o que significa que o arquivo não está associado a nenhuma tag. Um máximo de 10 tags pode ser especificado.

string

Não

A tag do arquivo. Cada tag pode ter até 12 caracteres e suporta caracteres da categoria de letras Unicode (incluindo letras em inglês, caracteres chineses e dígitos), sublinhados (_) e hifens (-).

产品介绍

OverWriteFileByOssKey

boolean

Não

Especifica se deve substituir arquivos com o mesmo OssKey na categoria. Valor padrão: false, o que significa que os arquivos não são substituídos.

false

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

Code

string

O código de erro.

success

Data

object

O campo de dados retornado pela operação.

AddFileResultList

array<object>

A lista de resultados de importação de arquivos.

object

A lista de resultados de importação de arquivos.

FileId

string

O ID do arquivo. Mantenha este valor seguro, pois ele será usado para todas as operações de API subsequentes relacionadas a este arquivo.

file_809f469a59ac449586ec692576xxxxx_102248XXX

OssKey

string

O nome da chave (Key) do arquivo importado no bucket do OSS.

root/path/this_is_temp_xxxx.pdf

Status

string

Status de importação do arquivo. Valores possíveis:

  • SUCCESS: Importação (dados da aplicação) concluída.

  • FAILED: Falha na importação (dados da aplicação).

Apenas arquivos com o status SUCCESS podem ser usados para criar ou atualizar bases de conhecimento.

SUCCESS

Msg

string

Informações de erro retornadas quando a importação do arquivo falha.

size too large

Message

string

A mensagem de erro.

Cant find out category for category_id param.

RequestId

string

O ID da solicitação.

17204B98-xxxx-4F9A-8464-2446A84821CA

Status

string

O código de status retornado pela operação.

200

Success

string

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

  • true: Bem-sucedido.

  • false: Falha.

true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "success",
  "Data": {
    "AddFileResultList": [
      {
        "FileId": "file_809f469a59ac449586ec692576xxxxx_102248XXX",
        "OssKey": "root/path/this_is_temp_xxxx.pdf",
        "Status": "SUCCESS",
        "Msg": "size too large"
      }
    ]
  },
  "Message": "Cant find out category for category_id param.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "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.