跳转至

快速入门

本指南将帮助您开始使用MaaS API。我们将引导您创建一个简单的AI模型

步骤1:登录控制台获取访问密钥

以您的帐户登录Cloudsway控制台后,您可以参考下图找到您的访问密钥AK信息,AK是用于访问MaaS API的凭证,请您妥善保存

登录页面在这里alt text

从用户配置文件菜单获取您的访问密钥。 alt text

然后您可以看到您的访问密钥。 alt text

步骤2:访问MaaS API购买资源

导航到MaaS API,在模型列表点击创建。根据需求选择模型,可以给资源打上标签,以及分类到指定的资源组,便于后续管理 alt text

创建完毕会在列表页看到生成对应的endpoint。同时支持对endpoint启用和禁用 alt text

步骤3:完成调用

从控制台获取到AK信息后,有两种调用方式

统一域名调用

1.先获取已购买的模型列表

    ```shell
    curl --location 'https://genaiapi.cloudsway.net/v1/models' \
    --header 'Authorization: Bearer YOUR_ACCESS_KEY'
    ```

上述操作返回会列举该AK账号拥有的所有模型

    ```shell
    {
        "data": [

            {
                "id": "MaaS 1.5 Pro",
                "created": "1720089491",
                "object": "model",
                "owned_by": "system"
            },
            {
                "id": "MaaS 3 Haiku",
                "created": "1720514922",
                "object": "model",
                "owned_by": "system"
            },
            {
                "id": "MaaS 3 Opus",
                "created": "1720514934",
                "object": "model",
                "owned_by": "system"
            },
            {
                "id": "MaaS ASpeech",
                "created": "1723607825",
                "object": "model",
                "owned_by": "system"
            }
        ],
        "object": "list"
    }
    ```

2.从上述模型列表中指定模型调用

model字段,一定要和返回的模型列表里的值保持一致。以文本模型为例

    ```shell
    curl --location 'https://genaiapi.cloudsway.net/v1/chat/completions' \
    --header 'Authorization: Bearer YOUR_ACCESS_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
        "messages": [

            {
                "role": "user", 
                "content": [
                    {
                        "type": "text", 
                        "text": "hi"
                    }
                ]
            }
        ], 
        "model":"MaaS 4o mini",
        "stream": false,
        "stream_options":{"include_usage":true}
    }'
    ```

指定一个endpoint调用模型

从控制台获取到的AK信息 和endpoint信息去完成调用

    ```
    curl -X POST 'https://genaiapi.cloudsway.net/v1/ai/sVUARttwSjilLOZY/chat/completions' -H 'Authorization: Bearer YOU_API_KEY' -H 'Content-Type: application/json' --data '{
    "model": "gpt-4",
    "messages": [
        {
            "role": "user",
            "content": "hello"
        }
        ]
    }'
    ```

返回以下结果:

    ```
    {
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "logprobs": null,
            "messages": [
            {
                "role": "assistant",
                "content": "I'm doing well, thank you for asking. How can I help you today?"
            }
            ]
        }
    ],
    "created": 1632345678,
    "model": "gpt-4-turbo",
    "object": null,
    "system_fingerprint": null,
    "usage": {
        "completion_tokens": 100,
        "prompt_tokens": 20,
        "total_tokens": 120
    }
    }
    ```

步骤4:配置内容过滤器

登陆 MaaSAPI控制台,根据业务场景,以excel/csv格式上传敏感词,并绑定endpoint以生效。平台会根据上传的敏感词进行输入输出的过滤。

alt text

alt text

步骤5:控制台查看审计日志

登陆 MaaSAPI控制台,查看审计日志

alt text

步骤6:控制台查看监控数据

登陆 MaaSAPI控制台,查看用量,时延等数据

alt text

步骤7:管理资源组

您可以对资源进行分类,将资源转入到指定的资源组里。这样便于后续的账单统计

1.创建资源组

访问 资源组,查看资源组信息,可以创建,删除资源组,以及对资源的转入转出

alt text

2.将其他资源转入该资源组 alt text

3.将资源转出至其他资源组 alt text

4.查看资源组视角的账单详情 访问账单,点击下载,导出到本地的账单表格中有一些资源组视角的费用 alt text