异步调用API参考

Python

from openai import AsyncOpenAI
import asyncio
import os

# 若没有配置环境变量，可用百炼API Key将下行替换为：api_key="sk-xxx"。但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
api_key=os.getenv("DASHSCOPE_API_KEY")
app_id='APP_ID' # 替换为实际的应用 ID
base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'

# 初始化异步客户端
client = AsyncOpenAI(
  api_key=api_key,
  base_url=base_url
)

async def main():
  # 异步调用
  response = await client.responses.create(
    input="你是谁？",
    background=True
  )
    
  # 打印完整的响应JSON对象
  print(response.model_dump_json(indent=2))

# 运行异步主函数
if __name__ == "__main__":
  asyncio.run(main())

curl

# 若没有配置环境变量，请将 {DASHSCOPE_API_KEY} 替换为实际的阿里云百炼API Key，但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
# 请将 APP_ID 替换为实际的应用ID
# 实际使用时请删除注释内容
curl --location "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
--data '{
    "input": "你是谁？",
    "background": true
}'

Python

import asyncio
import os
from openai import AsyncOpenAI

# 若没有配置环境变量，可用百炼API Key将下行替换为：api_key="sk-xxx"。但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
api_key=os.getenv("DASHSCOPE_API_KEY")
app_id='APP_ID' # 1、替换为实际的应用 ID
base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'

# 初始化客户端
client = AsyncOpenAI(api_key=api_key, base_url=base_url)

async def main():
  # 查询任务状态
  response = await client.responses.retrieve("6e4ba287-0e93-4d67-9955-ef1017ed3384") # 2、替换为实际的任务 ID
  print(response.model_dump_json(indent=2))

if __name__ == "__main__":
  asyncio.run(main())

curl

# 若没有配置环境变量，请将 {DASHSCOPE_API_KEY} 替换为实际的阿里云百炼API Key，但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
# 1、请将 APP_ID 替换为实际的应用ID
# 2、请将 RESPONSE_ID 替换为创建异步任务返回的ID
# 实际使用时请删除注释内容
curl "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses/{RESPONSE_ID}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DASHSCOPE_API_KEY}"

Python

import asyncio
import os
from openai import AsyncOpenAI

# 若没有配置环境变量，可用百炼API Key将下行替换为：api_key="sk-xxx"。
# 不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
api_key = os.getenv("DASHSCOPE_API_KEY")
app_id = 'APP_ID'  # 1. 替换为您的应用ID
base_url = f'https://dashscope.aliyuncs.com/api/v2/apps/agent/{app_id}/compatible-mode/v1/'

client = AsyncOpenAI(api_key=api_key, base_url=base_url)

async def main():
    # 2. 替换为要删除的任务ID
    response_id_to_delete = "b17c64f94-7034-403e-aef5-4f48647656d5" 
    try:
        response_wrapper = await client.responses.with_raw_response.delete(response_id_to_delete)
        http_response = response_wrapper.http_response
        response_json = http_response.json()

        # 检查响应内容中的 "deleted" 字段是否为 true。
        if response_json.get("deleted") is True:
            print("任务记录已成功删除。")
            print(response_json)
        else:
            print("删除操作未成功")
            print(response_json)

    except Exception as e:
        print(f"\n调用API时发生严重错误: {e}")

if __name__ == "__main__":
    asyncio.run(main())

curl

# 若没有配置环境变量，请将 {DASHSCOPE_API_KEY} 替换为实际的阿里云百炼API Key，但不建议在生产环境中直接将API Key硬编码到代码中，以减少API Key泄露风险。
# 1、请将 APP_ID 替换为实际的应用ID
# 2、请将 RESPONSE_ID 替换为创建异步任务返回的ID
# 实际使用时请删除注释内容
curl -X DELETE "https://dashscope.aliyuncs.com/api/v2/apps/agent/{APP_ID}/compatible-mode/v1/responses/{RESPONSE_ID}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DASHSCOPE_API_KEY}"