Skip to main content
Geração de Texto

Model import

A API de importação de modelos do Model Studio oferece interfaces completas para criar, consultar, listar e excluir tarefas de importação. Com ela, você importa arquivos de modelos com ajuste fino do OSS diretamente para o Model Studio.

Visão geral

A API de importação de modelos permite importar arquivos de modelos com ajuste fino armazenados no OSS para o Model Studio. Após a importação, implante o modelo como um service chamável por meio da API de criação de implantação. A importação suporta dois tipos de modelo: ajuste fino de parâmetros completos (full) e ajuste fino LoRA (lora). O fluxo completo de importação de modelos é o seguinte: crie uma tarefa de importação → consulte os detalhes da tarefa (verifique o status periodicamente) → crie uma implantação após o sucesso da tarefa → liste e exclua as tarefas desnecessárias.
A API de importação de modelos está disponível atualmente apenas na região Singapore. Se você estiver usando outra região, utilize o console do Model Studio nessa região para importar modelos.

Pré-requisitos

  • Configure sua chave de API do Model Studio. Para mais informações, consulte Obter uma chave de API.
  • Crie um bucket do OSS e autorize o Model Studio a acessá-lo. Para mais informações, consulte os pré-requisitos em Importação de modelos.
  • Carregue os arquivos de modelo no bucket do OSS e garanta que estejam em conformidade com Importação de modelos.

Cabeçalhos de solicitação comuns

Todas as operações de API exigem os seguintes campos no cabeçalho HTTP:

Cabeçalho

Descrição

Authorization

Bearer ${DASHSCOPE_API_KEY}. Para mais informações sobre como obter uma chave de API, consulte Obter uma chave de API.

Content-Type

application/json

Objeto de modelo personalizado

Um objeto de modelo personalizado descreve todas as informações de uma tarefa de importação. Ele é criado por meio da API Criar uma tarefa de importação e pode ser recuperado pelas APIs Consultar detalhes da tarefa de importação e Listar tarefas de importação. Após a importação, implante o modelo usando a API Criar uma implantação. Um objeto de modelo personalizado contém os seguintes campos:

Campos do objeto

Parâmetro

Tipo

Descrição

request_id

String

O ID da solicitação.

output.job_id

String

O ID da tarefa de importação, usado para consultar o status da tarefa ou excluí-la.

output.model_name

String

O identificador do modelo gerado pelo sistema, composto pelo nome do modelo base seguido por um sufixo de carimbo de data/hora.

output.display_name

String

O nome de exibição do modelo importado.

output.source

String

A origem da importação. O valor retornado é OSS em maiúsculas.

output.weight_type

String

O tipo de ajuste fino.

output.storage_info

Object

As informações de armazenamento da origem da importação, incluindo bucket_name e object_key.

output.status

String

O status da tarefa. Para mais informações, consulte Status da tarefa.

output.gmt_create

String

O horário de criação da tarefa no formato ISO 8601. Exemplo: 2024-01-01T12:00:00.000+00:00.

Status da tarefa

Uma tarefa de importação pode apresentar os seguintes status durante seu ciclo de vida:

Status

Descrição

PENDING

A tarefa foi enviada e aguarda processamento.

RUNNING

A tarefa está em execução. O sistema valida e importa os arquivos do modelo.

SUCCESSED

A tarefa foi concluída com êxito. O modelo foi importado e pode ser implantado por meio da API Criar uma implantação.

FAILED

A execução da tarefa falhou. Consulte os detalhes da tarefa para obter o error_code correspondente ao motivo da falha.

Criar uma tarefa de importação

Envie uma tarefa de importação de modelo. O sistema valida a estrutura e a segurança dos arquivos do modelo para garantir a implantação correta.

Endpoint

POST https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import

Exemplo de solicitação

curl -X POST "https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import" \
    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
        "model_name": "qwen3-32b",
        "display_name": "My LoRA fine-tuned model",
        "source": "oss",
        "weight_type": "lora",
        "storage_info": {
            "bucket_name": "my-model-bucket",
            "object_key": "models/qwen3-32b-lora/"
        }
    }'

Parâmetros da solicitação

Parâmetro

Tipo

Posição

Obrigatório

Descrição

model_name

String

body

Sim

Nome do modelo base. Corresponde ao campo Base Model no console. Para ver os modelos suportados, consulte Importação de modelos. Exemplo: qwen3-32b.

display_name

String

body

Não

Nome de exibição do modelo importado. Corresponde ao campo Model Name no console. Máximo de 50 caracteres. Se não especificado, o nome do modelo base será usado por padrão.

source

String

body

Sim

Origem da importação. Corresponde ao campo Import Source no console. Atualmente, apenas oss (importação do OSS) é suportado. A resposta retorna OSS em maiúsculas.

weight_type

String

body

Sim

Tipo de ajuste fino. full indica um modelo com ajuste fino de parâmetros completos. lora indica um modelo com ajuste fino LoRA.

storage_info

Object

body

Sim

Informações de armazenamento da origem da importação.

storage_info.bucket_name

String

body

Sim

Nome do bucket do OSS. Corresponde ao campo Bucket no console.

storage_info.object_key

String

body

Sim

Prefixo do caminho do OSS para os arquivos do modelo. Deve terminar com /. Exemplo: models/qwen3-32b-lora/.

Exemplo de resposta

{
    "request_id": "6c6b****-3fea-****-bc26-c9e2********",
    "output": {
        "job_id": "937b****-2a4f-****-8abe-c2fa********",
        "model_name": "qwen3-32b-offline-20240101-abc1",
        "display_name": "My LoRA fine-tuned model",
        "source": "OSS",
        "weight_type": "lora",
        "storage_info": {
            "bucket_name": "my-model-bucket",
            "object_key": "models/qwen3-32b-lora/"
        },
        "status": "PENDING",
        "gmt_create": "2024-01-01T12:00:00.000+00:00"
    }
}

Parâmetros da resposta

Parâmetro

Tipo

Descrição

request_id

String

O ID da solicitação.

output.job_id

String

O ID da tarefa de importação, utilizável nas APIs Consultar detalhes da tarefa de importação, Listar tarefas de importação e Excluir uma tarefa de importação.

output.model_name

String

O identificador do modelo gerado pelo sistema, composto pelo nome do modelo base seguido por um sufixo de carimbo de data/hora.

output.display_name

String

O nome de exibição do modelo importado.

output.source

String

A origem da importação. O valor retornado é OSS em maiúsculas.

output.weight_type

String

O tipo de ajuste fino.

output.storage_info

Object

As informações de armazenamento da origem da importação, incluindo bucket_name e object_key.

output.status

String

O status da tarefa. Para mais informações, consulte Status da tarefa.

output.gmt_create

String

O horário de criação da tarefa no formato ISO 8601. Exemplo: 2024-01-01T12:00:00.000+00:00.

Consultar detalhes da tarefa de importação

Consulte o status atual e os detalhes de uma tarefa de importação específica.

Endpoint

GET https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import/{job_id}

Exemplo de solicitação

curl "https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import/937b****-2a4f-****-8abe-c2fa********" \
    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
    --header "Content-Type: application/json"

Parâmetros da solicitação

Parâmetro

Tipo

Posição

Obrigatório

Descrição

job_id

String

path

Sim

O ID da tarefa de importação, obtido por meio da API Criar uma tarefa de importação ou Listar tarefas de importação.

Exemplo de resposta

{
    "request_id": "ca21****-b91b-****-bd35-c41c********",
    "output": {
        "job_id": "937b****-2a4f-****-8abe-c2fa********",
        "model_name": "qwen3-32b-offline-20240101-abc1",
        "display_name": "My LoRA fine-tuned model",
        "source": "OSS",
        "storage_info": {
            "bucket_name": "my-model-bucket",
            "object_key": "models/qwen3-32b-lora/"
        },
        "status": "RUNNING",
        "gmt_create": "2024-01-01T12:00:00.000+00:00"
    }
}

Parâmetros da resposta

Os parâmetros da resposta são praticamente idênticos aos da API Criar uma tarefa de importação, exceto pela ausência do campo weight_type. Em caso de falha na tarefa, a resposta inclui o campo adicional error_code indicando o motivo.

Listar tarefas de importação

Consulte a lista paginada de tarefas de importação no workspace atual.

Endpoint

GET https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import

Exemplo de solicitação

curl "https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import?page_no=1&page_size=10" \
    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
    --header "Content-Type: application/json"
Filtrar por status:
curl "https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import?page_no=1&page_size=10&status=SUCCESSED" \
    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
    --header "Content-Type: application/json"

Parâmetros da solicitação

Parâmetro

Tipo

Posição

Obrigatório

Descrição

page_no

Integer

query

Não

Número da página. Valor padrão: 1.

page_size

Integer

query

Não

Número de entradas por página. Valor padrão: 10. Valor máximo: 100.

status

String

query

Não

Filtro por status da tarefa. Para mais informações, consulte Status da tarefa.

model_name

String

query

Não

Filtro por nome do modelo. É necessário informar o nome gerado pelo sistema retornado na resposta (correspondência exata).

Exemplo de resposta

{
    "request_id": "ca21****-b91b-****-bd35-c41c********",
    "output": {
        "total": 2,
        "page_no": 1,
        "page_size": 10,
        "list": [
            {
                "job_id": "937b****-2a4f-****-8abe-c2fa********",
                "model_name": "qwen3-32b-offline-20240101-abc1",
                "display_name": "My LoRA fine-tuned model",
                "status": "SUCCESSED",
                "source": "OSS",
                "storage_info": {
                    "bucket_name": "my-model-bucket",
                    "object_key": "models/qwen3-32b-lora/"
                },
                "gmt_create": "2024-01-01T12:00:00.000+00:00"
            },
            {
                "job_id": "edb0****-39ac-****-9859-8b1e********",
                "model_name": "qwen3-32b-offline-20240102-xyz4",
                "display_name": "My full-parameter fine-tuned model",
                "status": "FAILED",
                "source": "OSS",
                "storage_info": {
                    "bucket_name": "my-model-bucket",
                    "object_key": "models/qwen3-32b-full/"
                },
                "error_code": "Failed to retrieve files from OSS. Please check the files in OSS.",
                "gmt_create": "2024-01-02T09:00:00.000+00:00"
            }
        ]
    }
}

Parâmetros da resposta

Parâmetro

Tipo

Descrição

request_id

String

O ID da solicitação.

output.total

Integer

Total de tarefas correspondentes aos critérios de consulta.

output.page_no

Integer

Número da página atual.

output.page_size

Integer

Número de entradas por página.

output.list

Array

Lista de tarefas de importação. Cada elemento possui os mesmos campos dos parâmetros de resposta da API Criar uma tarefa de importação, exceto pela ausência do campo weight_type. O campo adicional error_code aparece quando a tarefa falha.

Excluir uma tarefa de importação

Exclua uma tarefa de importação específica e seus arquivos de modelo associados. Apenas tarefas com status SUCCESSED ou FAILED podem ser excluídas. Após a exclusão bem-sucedida, o sistema retorna os detalhes da tarefa removida.

Endpoint

DELETE https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import/{job_id}

Exemplo de solicitação

curl -X DELETE "https://dashscope-intl.aliyuncs.com/api/v1/custom_models/import/937b****-2a4f-****-8abe-c2fa********" \
    --header "Authorization: Bearer $DASHSCOPE_API_KEY" \
    --header "Content-Type: application/json"

Parâmetros da solicitação

Parâmetro

Tipo

Posição

Obrigatório

Descrição

job_id

String

path

Sim

O ID da tarefa de importação, obtido por meio da API Criar uma tarefa de importação ou Listar tarefas de importação.

Exemplo de resposta

{
    "request_id": "e22b****-b20a-****-bf23-9b53********",
    "output": {
        "job_id": "937b****-2a4f-****-8abe-c2fa********",
        "model_name": "qwen3-32b-offline-20240101-abc1",
        "display_name": "My LoRA fine-tuned model",
        "source": "OSS",
        "storage_info": {
            "bucket_name": "my-model-bucket",
            "object_key": "models/qwen3-32b-lora/"
        },
        "status": "SUCCESSED",
        "gmt_create": "2024-01-01T12:00:00.000+00:00"
    }
}

Parâmetros da resposta

Parâmetro

Tipo

Descrição

request_id

String

O ID da solicitação.

output

Object

Detalhes da tarefa excluída. Os campos são praticamente idênticos aos parâmetros de resposta da API Criar uma tarefa de importação, exceto pela ausência do campo weight_type.

Respostas de erro

Em caso de erro, a API retorna uma resposta no seguinte formato:
{
    "request_id": "ca21****-b91b-****-bd35-c41c********",
    "code": "OperationDenied",
    "message": "The import job is currently running and cannot be deleted."
}

Códigos de erro

Código de erro

Descrição

InvalidParameter

Parâmetro de solicitação inválido. Por exemplo, um parâmetro obrigatório está ausente, o formato está incorreto ou o valor é inválido.

NotFound

O recurso especificado não existe. Por exemplo, o job_id não existe, o usuário não tem acesso ou o modelo base não suporta importação.

OperationDenied

Operação negada. Por exemplo, tentativa de excluir uma tarefa com status RUNNING.

InvalidApiKey

Chave de API inválida ou não fornecida.

InternalError

Erro interno do sistema. Tente novamente mais tarde.

Referência da API de Geração de Texto
Geração de Imagens
  • FAQ
Geração de Vídeo
Áudio
API em tempo real
Incorporação de Texto
Produção de Modelos