子业务空间的模型调用 - 大模型服务平台百炼

本文主要介绍如何调用指定的业务空间的模型。

重要

通常情况下，通过主账号的API Key调用模型中心的模型时，不需要传递业务空间ID。只有当使用子账号的API Key调用模型时，需要通过某个业务空间进行模型的调用，才需要传递业务空间ID。

注：通过子账号在默认业务空间下生成的API Key，可以访问默认业务空间，也可以调用默认业务空间的模型和应用。

前提条件

已开通百炼服务并获取API Key: 获取API Key。

已创建业务空间并获取业务空间ID：如何使用业务空间。
已授权子账号业务空间权限：RAM子账号使用方式和授权操作。
已授权子业务空间的模型调用权限：授权子业务空间模型调用。

调用示例

SDK调用示例

以下示例展示了调用RAG检索增强应用进行企业知识库问答的代码。

说明

需要使用您的API Key替换示例中的YOUR_API_KEY，使用业务空间ID替换示例中的YOUR_WORKSPACE，代码才能正常运行。请参考获取业务空间 ID获取业务空间ID。

python sdk version: dashscope>=1.17.0

java sdk version: >=2.12.0

设置API Key

export DASHSCOPE_API_KEY=YOUR_API_KEY

代码示例

以下示例通过代码调用子空间的模型。

Python

import os
import dashscope

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

messages = [
    {'role': 'system', 'content': 'You are a helpful assistant.'},
    {'role': 'user', 'content': '你是谁？'}
    ]
response = dashscope.Generation.call(
    # 若没有配置环境变量，请用百炼API Key将下行替换为：api_key="sk-xxx",
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="qwen-plus", 
    messages=messages,
    result_format='message',
    workspace='YOUR_WORKSPACE'
    )
print(response)

Java

// 建议dashscope SDK的版本 >= 2.12.0
import java.util.Arrays;
import java.lang.System;
import com.alibaba.dashscope.protocol.Protocol;
import com.alibaba.dashscope.aigc.generation.Generation;
import com.alibaba.dashscope.aigc.generation.GenerationParam;
import com.alibaba.dashscope.aigc.generation.GenerationResult;
import com.alibaba.dashscope.common.Message;
import com.alibaba.dashscope.common.Role;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.JsonUtils;

public class Main {
    public static GenerationResult callWithMessage() throws ApiException, NoApiKeyException, InputRequiredException {
        Generation gen = new Generation(Protocol.HTTP.getValue(), "https://dashscope-intl.aliyuncs.com/api/v1");
        Message systemMsg = Message.builder()
                .role(Role.SYSTEM.getValue())
                .content("You are a helpful assistant.")
                .build();
        Message userMsg = Message.builder()
                .role(Role.USER.getValue())
                .content("你是谁？")
                .build();
        GenerationParam param = GenerationParam.builder()
                // 若没有配置环境变量，请用百炼API Key将下行替换为：.apiKey("sk-xxx")
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .model("qwen-plus")
                .workspace("YOUR_WORKSPACE")
                .messages(Arrays.asList(systemMsg, userMsg))
                .resultFormat(GenerationParam.ResultFormat.MESSAGE)
                .build();
        return gen.call(param);
    }
    public static void main(String[] args) {
        try {
            GenerationResult result = callWithMessage();
            System.out.println(JsonUtils.toJson(result));
        } catch (ApiException | NoApiKeyException | InputRequiredException e) {
            // 使用日志框架记录异常信息
            System.err.println("An error occurred while calling the generation service: " + e.getMessage());
        }
        System.exit(0);
    }
}

API请求示例（SSE关闭）

以下示例展示通过CURL命令来调用子空间的模型的脚本。

说明

需要使用您的API Key替换示例中的YOUR_API_KEY，使用业务空间ID替换示例中的YOUR_WORKSPACE，代码才能正常运行。请参考获取业务空间 ID获取业务空间ID。

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/services/aigc/text-generation/generation' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--header 'X-DashScope-WorkSpace: {YOUR_WORKSPACE}' \
--data '{
    "model": "qwen-turbo",
    "input":{
        "messages":[      
            {
                "role": "system",
                "content": "You are a helpful assistant."
            },
            {
                "role": "user",
                "content": "如何做炒西红柿鸡蛋？"
            }
        ]
    },
    "parameters": {
    }
}'

API请求示例（SSE开启）

以下示例展示通过CURL命令来调用子空间的模型的脚本。

说明

需要使用您的API Key替换示例中的YOUR_API_KEY，使用业务空间ID替换示例中的YOUR_WORKSPACE，代码才能正常运行。请参考获取业务空间 ID获取业务空间ID。

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/services/aigc/text-generation/generation' \
--header 'Authorization: Bearer {YOUR_API_KEY}' \
--header 'Content-Type: application/json' \
--header 'X-DashScope-WorkSpace: {YOUR_WORKSPACE}' \
--header 'X-DashScope-SSE: enable' \
--data '{
    "model": "qwen-turbo",
    "input":{
        "messages":[      
            {
                "role": "system",
                "content": "You are a helpful assistant."
            },
            {
                "role": "user",
                "content": "如何做炒西红柿鸡蛋？"
            }
        ]
    },
    "parameters": {
    }
}'