Copy

A Assistant API está sendo descontinuada. Migre para a Responses API como alternativa. A Responses API inclui várias ferramentas integradas e oferece suporte ao gerenciamento de contexto em múltiplas interações.

Listar etapas de execução

Retorna uma lista de todas as etapas de uma tarefa de execução.

Exemplo de solicitação

HTTP
SDK

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_cc2a3e9d-436b-482b-91c5-377e0f376506/runs/run_3de634fa-75d4-4370-adcf-92ba2a60c396/steps?limit=20&order=asc' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

from dashscope import Steps
import os

steps = Steps.list(
    'run_id',
    # We recommend setting the API key as an environment variable. If not, replace `api_key=os.getenv(...)` with `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    limit=20
)

import com.alibaba.dashscope.common.GeneralListParam;
import com.alibaba.dashscope.common.ListResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.runs.RunStep;
import com.alibaba.dashscope.threads.runs.Runs;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Runs runs = new Runs();
        // We recommend setting the API key as an environment variable. If not, replace `apiKey(System.getenv(...))` with `apiKey("your_api_key")`.
        GeneralListParam listSteps = GeneralListParam.builder()
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        ListResult<RunStep> run = runs.listSteps("threadId", "runId", listSteps);
    }
}

import dashscope
from dashscope import Steps
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
steps = Steps.list(
    'run_id',
    # We recommend setting the API key as an environment variable. If not, replace `api_key=os.getenv(...)` with `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    limit=20
)

import com.alibaba.dashscope.common.GeneralListParam;
import com.alibaba.dashscope.common.ListResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.runs.RunStep;
import com.alibaba.dashscope.threads.runs.Runs;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Runs runs = new Runs();
        // We recommend setting the API key as an environment variable. If not, replace `apiKey(System.getenv(...))` with `apiKey("your_api_key")`.
        GeneralListParam listSteps = GeneralListParam.builder()
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        ListResult<RunStep> run = runs.listSteps("threadId", "runId", listSteps);
    }
}

Corpo da solicitação

Nome do parâmetro	Tipo	Obrigatório	Padrão	Descrição
run_id	string	Sim		O ID da execução cujas etapas você deseja listar.
thread_id	string	Sim		O ID da Thread.
limit	integer	Não	None	Quantidade de etapas de execução a serem recuperadas. O padrão é None. Um valor None utiliza o valor padrão do lado do servidor.
order	string	Não	None	Ordem de classificação dos resultados com base no campo created_at. Defina este parâmetro como asc (ascendente) ou desc (descendente). O valor padrão é None, o que indica o uso do método de classificação padrão do servidor.
after	string	Não	None	ID da etapa de execução usada como cursor para paginação. Quando fornecido, retorna a página de resultados imediatamente posterior a esta etapa.
before	string	Não	None	ID da etapa de execução usada como cursor para paginação. Quando fornecido, retorna a página de resultados imediatamente anterior a esta etapa.
workspace	string	Sim	None	O Workspace ID do Alibaba Cloud Model Studio é obrigatório apenas se a `api_key` for uma chave de API de um sub-workspace.
api_key	string	Sim	None	A API Key do Model Studio. Recomendamos que você configure a API Key como uma variável de ambiente.

Exemplo de resposta

{
    "object": "list",
    "data": [
        {
            "id": "[REDACTED]",
            "object": "thread.run.step",
            "created_at": 1711517599333,
            "assistant_id": "[REDACTED]",
            "thread_id": "[REDACTED]",
            "run_id": "[REDACTED]",
            "type": "message_creation",
            "status": "completed",
            "step_details": {
                "type": "message_creation",
                "message_creation": {
                    "message_id": "[REDACTED]"
                }
            },
            "last_error": {
                "code": "",
                "message": ""
            },
            "expired_at": 0,
            "cancelled_at": -1,
            "failed_at": -1,
            "completed_at": -1,
            "metadata": {},
            "usage": {}
        }
    ],
    "first_id": "[REDACTED]",
    "last_id": "[REDACTED]",
    "has_more": false,
    "request_id": "[REDACTED]"
}

Corpo da resposta

Uma lista de objetos de etapa de execução

Recuperar uma etapa de execução

Exemplo de solicitação

HTTP
SDK

Código de exemplo

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_cc2a3e9d-436b-482b-91c5-377e0f376506/runs/run_3de634fa-75d4-4370-adcf-92ba2a60c396/steps/step_4db180b5-d44a-4b12-9390-4307c6cb87a5' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

Código de exemplo

from dashscope import Steps
import os

step = Steps.retrieve(
    'step_id',
    # We recommend setting the API key as an environment variable. If not, replace `api_key=os.getenv(...)` with `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    run_id='run_id'
)

import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.runs.RunStep;
import com.alibaba.dashscope.threads.runs.Runs;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Runs runs = new Runs();
        // We recommend setting the API key as an environment variable. If not, replace `apiKey=System.getenv(...)` with `apiKey="your_api_key"`.
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        RunStep run = runs.retrieveStep("threadId", "runId", "stepId", apiKey);
    }
}

import dashscope
from dashscope import Steps
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

step = Steps.retrieve(
    'step_id',
    # We recommend setting the API key as an environment variable. If not, replace `api_key=os.getenv(...)` with `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    run_id='run_id'
)

import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.runs.RunStep;
import com.alibaba.dashscope.threads.runs.Runs;
import com.alibaba.dashscope.utils.Constants;

public class Main {
    static {
        Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
    }
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        Runs runs = new Runs();
        // We recommend setting the API key as an environment variable. If not, replace `apiKey=System.getenv(...)` with `apiKey="your_api_key"`.
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        RunStep run = runs.retrieveStep("threadId", "runId", "stepId", apiKey);
    }
}

Corpo da solicitação

Nome do parâmetro	Tipo	Obrigatório	Padrão	Descrição
step_id	string	Sim		O ID da RunStep a ser recuperada.
thread_id	string	Sim		O ID da Thread.
run_id	string	Sim		O ID da execução.
workspace	string	Sim	None	O Workspace ID do Alibaba Cloud Model Studio é obrigatório apenas se você estiver usando uma API Key de sub-workspace.
api_key	string	Sim	None	A API Key do Model Studio. Recomendamos que você configure a API Key como uma variável de ambiente.

Exemplo de resposta

{
    "assistant_id": "[REDACTED]",
    "cancelled_at": null,
    "completed_at": 1735025124000,
    "created_at": 1735025123150,
    "expired_at": null,
    "failed_at": null,
    "id": "[REDACTED]",
    "last_error": null,
    "metadata": {},
    "object": "thread.run.step",
    "request_id": "[REDACTED]",
    "run_id": "[REDACTED]",
    "status": "completed",
    "step_details": {
        "message_creation": {
            "message_id": "[REDACTED]"
        },
        "type": "message_creation"
    },
    "thread_id": "[REDACTED]",
    "type": "message_creation",
    "usage": null
}

Corpo da resposta

O objeto de etapa de execução correspondente ao ID especificado.

Objeto de etapa de execução

Representa uma etapa no processo de execução de uma run.

Exemplo de objeto

{
  "id": "[REDACTED]",
  "assistant_id": "[REDACTED]",
  "cancelled_at": null,
  "completed_at": 1678886400,
  "created_at": 1678886300,
  "expired_at": null,
  "failed_at": null,
  "last_error": null,
  "metadata": {
    "user_id": "[REDACTED]",
    "context": "order_processing"
  },
  "object": "thread.run.step",
  "run_id": "[REDACTED]",
  "status": "completed",
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "[REDACTED]"
    }
  },
  "thread_id": "[REDACTED]",
  "type": "message_creation",
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  }
}

Atributos do objeto

Nome do parâmetro	Tipo	Descrição
id	string	Identificador exclusivo da etapa de execução, referenciável em endpoints da API.
assistant_id	string	ID do assistente associado a esta etapa de execução.
cancelled_at	integer	Timestamp UNIX de 13 dígitos (em milissegundos) indicando quando a etapa foi cancelada.
completed_at	integer	Timestamp UNIX de 13 dígitos (em milissegundos) indicando a conclusão da etapa.
created_at	integer	Timestamp UNIX de 13 dígitos (em milissegundos) referente à criação da etapa.
expired_at	integer	Timestamp UNIX de 13 dígitos (em milissegundos) marcando a expiração da etapa. Se a execução pai expirar, a etapa também será considerada expirada.
failed_at	integer	Timestamp UNIX de 13 dígitos (em milissegundos) registrando a falha da etapa.
last_error	object	Último erro associado a esta etapa. Este parâmetro é nulo caso não tenham ocorrido erros.
metadata	map	Conjunto de até 16 pares chave-valor anexáveis ao objeto, utilizado para armazenar informações adicionais em formato estruturado. O comprimento máximo da chave é de 64 caracteres e o do valor é de 512 caracteres.
object	string	Tipo do objeto, sempre definido como thread.run.step.
run_id	string	ID da execução à qual esta etapa pertence.
status	string	Status atual da etapa. Valores válidos: in_progress, cancelled, failed, completed ou expired.
step_details	object	Detalhes específicos da etapa de execução.
thread_id	string	ID da thread em execução.
type	string	Tipo da etapa de execução. Valores válidos: message_creation ou tool_calls.
usage	object	Estatísticas de uso de recursos.
status_code	integer	Código de status HTTP. Observação: Este parâmetro destina-se ao processamento interno. Na maioria dos casos, não é necessário preocupar-se com ele.

Códigos de erro

Se uma chamada falhar e retornar uma mensagem de erro, consulte Códigos de erro para solucionar o problema.

​Listar etapas de execução

​Exemplo de solicitação

​Corpo da solicitação

​Exemplo de resposta

​Corpo da resposta

​Recuperar uma etapa de execução

​Exemplo de solicitação

​Corpo da solicitação

​Exemplo de resposta

​Corpo da resposta

​Objeto de etapa de execução

​Exemplo de objeto

​Atributos do objeto

​Códigos de erro

Listar etapas de execução

Exemplo de solicitação

Corpo da solicitação

Exemplo de resposta

Corpo da resposta

Recuperar uma etapa de execução

Exemplo de solicitação

Corpo da solicitação

Exemplo de resposta

Corpo da resposta

Objeto de etapa de execução

Exemplo de objeto

Atributos do objeto

Códigos de erro