Jalankan langkah (Tidak digunakan lagi) - Alibaba Cloud Model Studio

Run steps menggambarkan aksi yang diambil oleh agen selama suatu run, termasuk pemanggilan model dan tool.

PentingAssistant API akan segera tidak digunakan lagi. Migrasikan ke Responses API sebagai alternatif. Responses API mencakup beberapa tool bawaan dan mendukung manajemen konteks multi-turn.

List run steps

Mengembalikan daftar semua langkah dalam suatu task run.

Contoh permintaan

HTTP

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"

SDK

python

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',
    # Kami menyarankan menyetel kunci API sebagai variabel lingkungan. Jika tidak, ganti `api_key=os.getenv(...)` dengan `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    limit=20
)

java

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();
        // Kami menyarankan menyetel kunci API sebagai variabel lingkungan. Jika tidak, ganti `apiKey(System.getenv(...))` dengan `apiKey("your_api_key")`.
        GeneralListParam listSteps = GeneralListParam.builder()
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        ListResult<RunStep> run = runs.listSteps("threadId", "runId", listSteps);
    }
}

Isi permintaan

Nama Parameter	Tipe	Wajib	Bawaan	Deskripsi
run_id	string	Ya		ID dari Run yang langkah-langkahnya ingin Anda daftarkan.
thread_id	string	Ya		ID dari Thread.
limit	integer	Tidak	None	Jumlah langkah running yang akan diambil. Nilai bawaannya adalah None. Nilai None menggunakan nilai bawaan sisi server.
order	string	Tidak	None	Urutan pengurutan hasil berdasarkan bidang created_at. Anda dapat mengatur parameter ini menjadi asc (ascending) atau desc (descending). Nilai bawaannya adalah None, yang menunjukkan bahwa metode pengurutan bawaan sisi server digunakan.
after	string	Tidak	None	ID dari run step yang digunakan sebagai kursor untuk pagination. Jika disediakan, mengembalikan halaman hasil segera setelah langkah ini.
before	string	Tidak	None	ID dari run step yang digunakan sebagai kursor untuk pagination. Jika disediakan, mengembalikan halaman hasil segera sebelum langkah ini.
workspace	string	Ya	None	Workspace ID untuk Alibaba Cloud Model Studio hanya diperlukan jika `api_key` merupakan kunci API untuk sub-workspace.
api_key	string	Ya	None	API Key dari Model Studio. Kami menyarankan agar Anda mengonfigurasi API Key sebagai variabel lingkungan.

Contoh respons

{
    "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]"
}

Isi respons

Daftar objek run step

Retrieve a run step

Contoh permintaan

HTTP

Kode contoh

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"

SDK

Kode contoh

python

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',
    # Kami menyarankan menyetel kunci API sebagai variabel lingkungan. Jika tidak, ganti `api_key=os.getenv(...)` dengan `api_key="your_api_key"`.
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id',
    run_id='run_id'
)

java

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();
        // Kami menyarankan menyetel kunci API sebagai variabel lingkungan. Jika tidak, ganti `apiKey=System.getenv(...)` dengan `apiKey="your_api_key"`.
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        RunStep run = runs.retrieveStep("threadId", "runId", "stepId", apiKey);
    }
}

Isi permintaan

Nama parameter	Tipe	Wajib	Bawaan	Deskripsi
step_id	string	Ya		ID dari RunStep yang akan diambil.
thread_id	string	Ya		ID dari Thread.
run_id	string	Ya		ID dari Run.
workspace	string	Ya	None	Workspace ID untuk Alibaba Cloud Model Studio hanya diperlukan jika Anda menggunakan Kunci API sub-workspace.
api_key	string	Ya	None	API Key dari Model Studio. Kami menyarankan agar Anda mengonfigurasi API Key sebagai variabel lingkungan.

Contoh respons

{
    "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
}

Isi respons

Objek run step yang sesuai dengan ID yang ditentukan.

Run step object

Merupakan langkah dalam proses eksekusi suatu run.

Contoh objek

{
  "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
  }
}

Atribut objek

Nama Parameter	Type	Deskripsi
id	string	Pengidentifikasi unik dari run step, yang dapat dirujuk dalam endpoint API.
assistant_id	string	ID dari assistant yang terkait dengan run step ini.
cancelled_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat run step dibatalkan.
completed_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat run step diselesaikan.
created_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat run step dibuat.
expired_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat run step kedaluwarsa. Jika run induk telah kedaluwarsa, langkah tersebut juga dianggap kedaluwarsa.
failed_at	integer	Stempel waktu UNIX 13 digit (dalam milidetik) saat run step gagal.
last_error	object	Error terakhir yang terkait dengan run step ini. Parameter ini bernilai null jika tidak terjadi error.
metadata	map	Sekumpulan hingga 16 pasangan kunci-nilai yang dapat dilampirkan pada objek. Ini digunakan untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Panjang maksimum kunci adalah 64 karakter dan panjang maksimum nilai adalah 512 karakter.
object	string	Tipe objek, yang selalu bernilai thread.run.step.
run_id	string	ID dari run tempat run step ini berada.
status	string	Status dari run step. Nilai valid: in_progress, cancelled, failed, completed, atau expired.
step_details	object	Detail langkah run.
thread_id	string	ID dari thread yang sedang berjalan.
type	string	Tipe dari run step. Nilai valid: message_creation atau tool_calls.
usage	object	Statistik penggunaan sumber daya.
status_code	integer	Kode status HTTP. Catatan: Parameter ini digunakan untuk pemrosesan internal. Dalam kebanyakan kasus, Anda tidak perlu memperhatikan parameter ini.

Kode error

Jika panggilan gagal dan mengembalikan pesan error, lihat Pesan error untuk troubleshooting.