获取服务列表

更新时间：2024-11-04

注意： 为提升开发者使用体验，本文内容已合并至对应API文档，请查看API鉴权及调用-模型服务-模型服务V1-获取服务列表；本文档已于2024年6月28日在平台文档中心下线，内容不再更新。

功能介绍

用于根据服务类型获取服务列表，例如服务类型为chat类型，可以获取所有chat类型的服务列表。

注意事项

调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

调用示例

Python

import os
from qianfan import resources

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

from qianfan.resources.console.service import Service

resp = Service.list(["embeddings"])
print(resp)

返回示例

Python

QfResponse(code=200,
           headers={...},
           body={'log_id': '3014762423',
                 'result': {'common': [{'apiType': 'embeddings',
                                        'chargeStatus': 'OPENED',
                                        'name': 'Embedding-V1',
                                        'url': 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/embedding-v1',
                                        'versionList': [{'serviceStatus': 'Done',
                                                         'trainType': 'embedding'}]},
                                       {'apiType': 'embeddings',
                                        'chargeStatus': 'OPENED',
                                        'name': 'bge-large-zh',
                                        'url': 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_zh',
                                        'versionList': [{'serviceStatus': 'Done',
                                                         'trainType': 'embedding'}]},
                                       {'apiType': 'embeddings',
                                        'chargeStatus': 'OPENED',
                                        'name': 'bge-large-en',
                                        'url': 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/bge_large_en',
                                        'versionList': [{'serviceStatus': 'Done',
                                                         'trainType': 'embedding'}]},
                                       {'apiType': 'embeddings',
                                        'chargeStatus': 'OPENED',
                                        'name': 'tao-8k',
                                        'url': 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/embeddings/tao_8k',
                                        'versionList': [{'serviceStatus': 'Done',
                                                         'trainType': 'embedding'}]}],
                            'custom': []}},
           statistic={'request_latency': 0.526946,
                      'total_latency': 0.5281059946864843})

参数说明

请求参数

名称	类型	必填	描述
api_type_filter	List[str]	否	根据服务类型apiType筛选，可选值如下： · chat · completions · embeddings · text2image · image2text

返回参数

名称	类型	描述
log_id	string	请求ID
result	dict	请求结果

result说明

名称	类型	描述
common	array(serviceItem)	预置服务
custom	array(serviceItem)	自定义服务

serviceItem说明

名称	类型	描述
serviceId	int	服务id
serviceUuid	string	服务uuid
name	string	服务名称
url	string	服务endpoint
apiType	string	服务类型，说明： · chat · completions · embeddings · text2image · image2text
chargeStatus	string	付费状态，说明： · OPENING · OPENED · STOP · FREE
versionList	array(version)	服务版本列表

version说明

名称	类型	描述
aiModelId	string	发布该服务版本的模型id，只有自定义服务会返回该字段
aiModelVersionId	string	发布该服务版本的模型版本id，只有自定义服务会返回该字段
trainType	string	服务基础模型类型
serviceStatus	string	服务状态，说明（1）该字段值对应状态说明： · Done：已发布 · New：待发布 · Deploying：发布中 · Failed：发布失败 · Stopped：暂停服务（2）如果是预置服务，该字段为固定值Done

千帆大模型服务与开发平台ModelBuilder