华为云用户手册

  • 请求参数 请求类为RttsRequest,详见表3。 表3 RttsRequest 名称 参数类型 是否必选 说明 command String 是 需设置为START,表示开始识别请求。 text String 是 待合成的文本,文本长度限制小于500字符。 config Object 否 配置信息。请参考表 config数据结构。 表4 Config 名称 参数类型 是否必选 说明 audio_format String 否 语音格式头:pcm、alaw、ulaw。 默认:pcm sample_rate String 否 采样率:16000、8000。 默认:8000 property String 否 语音合成 特征字符串,组成形式为{language}_{speaker}_{domain},即“语种_人员标识_领域”。 language取值范围: chinese speaker取值范围: xiaoqi 正式女生 xiaoyu正式男生 xiaoyan情感女生 xiaowang童声 speaker(精品发音人)取值范围: huaxiaomei温柔女声发音人,仅支持pcm huaxiaofei朝气男声发音人,仅支持pcm domain取值范围: common,通用领域 默认:chinese_xiaoyan_common 实时语音合成和语音合成属于同一种资源,按次计费。实时语音合成普通发音人,每100字计一次。精品发音人每50字计一次。 speed Integer 否 语速。 取值范围:-500~500 默认值:0 pitch Integer 否 音高。 取值范围:-500~500 默认值:0 volume Integer 否 音量。 取值范围:0~100 默认值:50
  • 初始化Client 初始化RttsClient,其参数包括AuthInfo和SisConfig。 表1 AuthInfo 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak,可参考AK/SK认证。 sk 是 String 用户的sk,可参考AK/SK认证。 region 是 String 区域,如cn-north-4,参考终端节点。 projectId 是 String 项目ID,同region一一对应,参考获取项目ID。 endpoint 否 String 终端节点,参考地区和终端节点。 表2 SisConfig 参数名称 是否必选 参数类型 描述 connectionTimeout 否 Integer 连接超时,默认10000,单位ms。 readTimeout 否 Integer 读取超时,默认10000,单位ms。 websocketWaitTimeout 否 Integer websocket最大等待超时,默认20000,单位ms
  • AK/SK认证 使用服务API需要进行认证,目前SDK仅支持AK/SK认证方式。 使用AK/SK方式,需要用户提供AK和SK。 注册并登录华为云管理控制台。 在控制台中,鼠标移动至右上角的用户名处,在下拉列表中单击“我的凭证”。 单击“访问密钥”页签,在页签中,单击“新增访问密钥”。 在“身份验证”对话框中,输入当前用户的登录密码,通过邮箱或者手机进行验证,输入对应的验证码。 单击“确定”,下载认证账号的AK/SK,请妥善保管AK/SK信息。
  • 初始化Client 初始化SisClient,详细信息如下。 配置客户端连接参数。 默认配置 // 使用默认配置 HttpConfig config = HttpConfig.getDefaultHttpConfig(); 网络代理(可选) // 根据需要配置网络代理,网络代理默认的协议为 `http` 协议 config.withProxyHost("proxy.huaweicloud.com") .withProxyPort(8080) .withProxyUsername("test") .withProxyPassword("test"); 超时配置(可选) // 默认连接超时时间为60秒,可根据需要调整 config.withTimeout(60); SSL配置(可选) // 根据需要配置是否跳过SSL证书验证 config.withIgnoreSSLVerification(true); 配置认证信息。 配置AK、SK、project_id信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。 使用永久AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); 使用临时AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withSecurityToken(securityToken) .withProjectId(projectId) 认证参数说明: ak、sk:访问密钥信息,获取方法请参考AK/SK认证。 projectId:华为云项目ID,获取方法请参考获取项目ID。。 securityToken:采用临时AK、SK 认证场景下的安全票据,可以通过token获取或者通过委托授权获取。 初始化客户端(region和指定云服务enddpoint二选一即可)。 指定region方式(强烈推荐推荐) // 初始化客户端认证信息,使用当前客户端初始化方式可不填 projectId/domainId,以初始化 BasicCredentials 为例 BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk); // 初始化指定云服务的客户端 {Service}Client ,以初始化 Region 级服务Sis的 SisClient 为例 SisClient client = SisClient.newBuilder() .withHttpConfig(config) .withCredential(bhttps://developer.huaweicloud.com/endpoint?SISasicCredentials) .withRegion(SisRegion.valueOf("cn-north-4")) .build(); 指定云服务endpoint方式(可选) // 指定终端节点,以Sis服务北京四的 endpoint 为例 String endpoint = "https://sis-ext.cn-north-4.myhuaweicloud.com"; // 初始化客户端认证信息,需要填写相应 projectId/domainId,以初始化 BasicCredentials 为例 BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); // 初始化指定云服务的客户端 {Service}Client ,以初始化 Region 级服务SiS的 SisClient 为例 SisClient client = SisClient.newBuilder() .withHttpConfig(config) .withCredential(basicCredentials) .withEndpoint(endpoint) .build(); endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点。
  • 请求参数 请求类为RecognizeShortAudioRequest,该类的body参数为PostShortAudioReq。 PostShortAudioReq的包含data,和config两个参数,其中data为识别音频的base64格式的字符串。Config参数详见表1。 表1 Config 参数 是否必选 参数类型 描述 audioFormat 是 String 支持语音的格式,请参考表 audio_format取值范围。 property 是 String 所使用的模型特征串,通常是 “语种_采样率_领域”的形式,采样率需要与音频采样率保持一致,取值范围请参考表 property取值范围。 addPunc 否 String 表示是否在识别结果中添加标点,取值为“yes”和“no”,默认为“no”。 digitNorm 否 String 表示是否将语音中的数字识别为阿拉伯数字,取值为“yes” 和 “no”,默认为“yes”。 vocabularyId 否 String 热词表id,不使用则不填写。 创建热词表信息请参考创建热词表。 needWordInfo 否 String 表示是否在识别结果中输出分词结果信息,取值为“yes”和“no”,默认为“no”。 伪代码 com.huaweicloud.sdk.sis.v1.model.Config configbody = new com.huaweicloud.sdk.sis.v1.model.Config();configbody.setAudioFormat(com.huaweicloud.sdk.sis.v1.model.Config.AudioFormatEnum.fromValue("pcm16k16bit")); configbody.setProperty(com.huaweicloud.sdk.sis.v1.model.Config.PropertyEnum.fromValue("chinese_16k_general")); configbody.setAddPunc(com.huaweicloud.sdk.sis.v1.model.Config.AddPuncEnum.YES); RecognizeShortAudioRequest request = new RecognizeShortAudioRequest(); PostShortAudioReq body = new PostShortAudioReq();body.withData(encoded);body.withConfig(configbody); request.withBody(body);
  • 发送请求 RecognizeShortAudioResponse response = client.recognizeShortAudio(request); 返回体RecognizeShortAudioResponse的参数如下表所示。 状态码: 200 表2 响应Body参数 参数 是否必选 参数类型 描述 trace_id 是 String 服务内部的令牌,可用于在日志中追溯具体流程,调用失败无此字段。 在某些错误情况下可能没有此令牌字符串。 result 是 Result object 调用成功表示识别结果,调用失败时无此字段。 表3 Result 参数 是否必选 参数类型 描述 text 是 String 调用成功表示识别出的内容。 score 是 Float 调用成功表示识别出的置信度,取值范围:0~1。 word_info 否 Array of WordInfo objects 分词信息列表。 表4 WordInfo 参数 是否必选 参数类型 描述 start_time 否 Integer 起始时间。 end_time 否 Integer 结束时间。 word 否 String 分词。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 代码示例 如下示例仅供参考,最新代码请前往获取SDK章节获取并运行。 # -*- coding: utf-8 -*- from huaweicloud_sis.client.rtts_client import RttsClient from huaweicloud_sis.bean.rtts_request import RttsRequest from huaweicloud_sis.bean.callback import RttsCallBack from huaweicloud_sis.bean.sis_config import SisConfig import os # 鉴权参数 # 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全; # 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SIS_AK/HUAWEICLOUD_SIS_SK ak = os.getenv("HUAWEICLOUD_SIS_AK") # 从环境变量获取ak 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html assert ak is not None, "Please add ak in your develop environment" sk = os.getenv("HUAWEICLOUD_SIS_SK") # 从环境变量获取sk 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html assert sk is not None, "Please add sk in your develop environment" project_id = "" # project id 同region一一对应,参考https://support.huaweicloud.com/api-sis/sis_03_0008.html region = '' # region,如cn-north-4 text = '' # 待合成的文本 path = '' # 待合成的音频保存路径,如test.pcm class MyCallback(RttsCallBack): """ 回调类,用户需要在对应方法中实现自己的逻辑,其中on_response必须重写 """ def __init__(self, save_path): self._f = open(save_path, 'wb') def on_open(self): """ websocket连接成功会回调此函数 """ print('websocket connect success') def on_start(self, message): """ websocket 开始识别回调此函数 :param message: 传入信息 :return: - """ print('webscoket start to recognize, %s' % message) def on_response(self, data): """ 回调返回的音频合成数据,byte数组格式 :param data byte数组,合成的音频数据 :return: - """ print('receive data %d' % len(data)) self._f.write(data) def on_end(self, message): """ websocket 结束识别回调此函数 :param message: 传入信息 :return: - """ print('websocket is ended, %s' % message) self._f.close() def on_close(self): """ websocket关闭会回调此函数 """ print('websocket is closed') self._f.close() def on_error(self, error): """ websocket出错回调此函数 :param error: 错误信息 :return: - """ print('websocket meets error, the error is %s' % error) self._f.close() def rtts_example(): """ 实时语音合成demo 1. RttsClient 只能发送一次文本,如果需要多次发送文本,需要新建多个RttsClient 和 callback 2. 识别完成后服务端会返回end响应。 3. 当识别出现问题时,会触发on_error回调,同时会关闭websocket。 4. 实时语音合成会多次返回结果,demo的处理方式是将多次返回结果集合在一个音频文件里。 """ # step1 初始化RttsClient, 暂不支持使用代理 my_callback = MyCallback(path) config = SisConfig() # 设置连接超时,默认是10 config.set_connect_timeout(10) # 设置读取超时, 默认是10 config.set_read_timeout(10) # 设置websocket等待时间 config.set_websocket_wait_time(20) # websocket暂时不支持使用代理 rtts_client = RttsClient(ak=ak, sk=sk, use_aksk=True, region=region, project_id=project_id, callback=my_callback, config=config) # step2 构造请求 rtts_request = RttsRequest(text) # 设置属性字符串, language_speaker_domain, 默认chinese_xiaoyan_common, 参考api文档 rtts_request.set_property('chinese_xiaoyan_common') # 设置音频格式为pcm rtts_request.set_audio_format('pcm') # 设置采样率,8000 or 16000, 默认8000 rtts_request.set_sample_rate('8000') # 设置音量,[0, 100],默认50 rtts_request.set_volume(50) # 设置音高, [-500, 500], 默认0 rtts_request.set_pitch(0) # 设置音速, [-500, 500], 默认0 rtts_request.set_speed(0) # step3 合成 rtts_client.synthesis(rtts_request) # use enterprise_project_Id # headers = {'Enterprise-Project-Id': 'your enterprise project id'} # rtts_client.synthesis(rtts_request, headers) if __name__ == '__main__': rtts_example()
  • 请求参数 请求类为RttsRequest,详见表3。 表3 RttsRequest 参数名称 是否必选 参数类型 描述 text 是 String 待合成的文本。1-500字 audio_format 否 String 语音格式头:pcm、alaw、ulaw。 默认:pcm pitch 否 Integer 音高,[-500,500] ,默认是0。 speed 否 Integer 语速,[-500,500] ,默认是0。 volume 否 Integer 音量,[0,100],默认是50。 sample_rate 否 String 采样率,支持“8000”、“16000”,默认“8000”。 property 否 String 语音合成特征字符串,组成形式为{language}_{speaker}_{domain},即“语种_人员标识_领域”。 language取值范围: chinese speaker取值范围: xiaoqi 正式女生 xiaoyu正式男生 xiaoyan情感女生 xiaowang童声 speaker(精品发音人)取值范围: huaxiaomei温柔女声发音人,仅支持pcm huaxiaofei朝气男声发音人,仅支持pcm domain取值范围: common,通用领域 默认:chinese_xiaoyan_common 实时语音合成和语音合成属于同一种资源,按次计费。实时语音合成普通发音人,每100字计一次。精品发音人每50字计一次。
  • 初始化Client 初始化RttsClient详见表 RttsClient初始化参数。 表1 RttsClient初始化参数 参数名称 是否必选 参数类型 描述 ak 是 String 用户的ak,可参考AK/SK认证。 sk 是 String 用户的sk,可参考AK/SK认证。 region 是 String 区域,如:cn-north-4。具体请参考终端节点。 project_id 是 String 项目ID,同region一一对应,参考获取项目ID。 service_endpoint 否 String 终端节点,一般使用默认即可。 sis_config 否 Object 详见表2。 表2 SisConfig 参数名称 是否必选 参数类型 描述 connect_timeout 否 Integer 连接超时,默认10,单位s。 read_timeout 否 Integer 读取超时,默认10,单位s。 websocket_wait_time 否 Integer websocket最大等待时间,默认20,单位s。 proxy 否 List [host, port] 或 [host, port, username, password]。
  • 示例代码 如下示例仅供参考,最新代码请前往获取SDK章节获取并运行。 /* * Copyright (c) Huawei Technologies Co., Ltd. 2022-2022. All rights reserved. */ package com.huaweicloud.sis.android.demo.tts; import android.os.Bundle; import android.os.Handler; import android.os.Message; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; import androidx.annotation.NonNull; import androidx.appcompat.app.AppCompatActivity; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.core.http.HttpConfig; import com.huaweicloud.sdk.core.utils.StringUtils; import com.huaweicloud.sdk.sis.v1.SisClient; import com.huaweicloud.sdk.sis.v1.model.PostCustom TTS Req; import com.huaweicloud.sdk.sis.v1.model.RunTtsRequest; import com.huaweicloud.sdk.sis.v1.model.RunTtsResponse; import com.huaweicloud.sdk.sis.v1.model.TtsConfig; import com.huaweicloud.sdk.sis.v1.region.SisRegion; import com.huaweicloud.sis.android.demo.R; import com.huaweicloud.sis.android.demo.service.MediaPlayerService; import com.huaweicloud.sis.android.demo.Config; /** * 功能描述 * 语音合成 http * * @since 2022-07-18 */ public class SttsActivity extends AppCompatActivity { private EditText text; private TextView outResult; private Button startSoundRecording; private Button startPlay; private Handler handler; // 保存合成的base64字符串 private String base64Data; // 合成音频路径 private String createFilePath; // 客户端请求 private SisClient client; private MediaPlayerService mediaPlayerService; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.stts); } @Override protected void onStart() { super.onStart(); initView(); initResoureces(); } @Override protected void onDestroy() { mediaPlayerService.stopMyPlayer(createFilePath); super.onDestroy(); } // 初始化界面 private void initView() { text = findViewById(R.id.input_text); outResult = findViewById(R.id.out_result); startSoundRecording = findViewById(R.id.start); startPlay = findViewById(R.id.startplay); startSoundRecording.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { Runnable runnable = new Runnable() { @Override public void run() { String sttsRequestText = getSttsResponse(); Message message = new Message(); Bundle mBundle = new Bundle(); mBundle.putString("result", sttsRequestText); message.setData(mBundle); handler.sendMessage(message); } }; new Thread(runnable).start(); } }); startPlay.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View view) { if (!StringUtils.isEmpty(base64Data)) { createFilePath = mediaPlayerService.createAudioFile(getBaseContext(), "wav", base64Data); mediaPlayerService.startPlay(createFilePath); } } }); } /** * 初始化资源 * * @return */ private void initResoureces() { BasicCredentials auth = new BasicCredentials() .withAk(this.getString(R.string.HUAWEICLOUD_SDK_AK)) .withSk(this.getString(R.string.HUAWEICLOUD_SDK_SK)) .withProjectId(Config.PROJECT_ID); HttpConfig config = HttpConfig.getDefaultHttpConfig(); config.withIgnoreSSLVerification(true); client = SisClient.newBuilder() .withHttpConfig(config) .withCredential(auth) .withRegion(SisRegion.valueOf(Config.REGION)) .build(); handler = new Handler(getMainLooper()) { @Override public void handleMessage(@NonNull Message message) { super.handleMessage(message); switch (message.what) { case 0: Bundle bundle = message.getData(); String rstr = bundle.getString("result"); outResult.setText(rstr); break; default: Log.e("Unexpected value: ", String.valueOf(message.what)); } } }; mediaPlayerService = new MediaPlayerService(); } // 设置请求体 private RunTtsRequest getRunTtsRequest() { TtsConfig configbody = new TtsConfig(); configbody.setAudioFormat(TtsConfig.AudioFormatEnum.fromValue("wav")); configbody.setSampleRate(TtsConfig.SampleRateEnum.fromValue("8000")); configbody.setProperty(TtsConfig.PropertyEnum.fromValue("chinese_huaxiaomei_common")); RunTtsRequest request = new RunTtsRequest(); PostCustomTTSReq body = new PostCustomTTSReq(); body.withConfig(configbody); if (!StringUtils.isEmpty(text.getText().toString())) { body.withText(text.getText().toString()); } else { body.withText("请输入合成文本"); } request.withBody(body); return request; } // 发送请求 private String getSttsResponse() { RunTtsRequest request = getRunTtsRequest(); String ttsString = ""; try { RunTtsResponse response = client.runTts(request); if (response.getResult().getData() != null) { base64Data = response.getResult().getData(); ttsString = "合成成功"; } else { ttsString = "合成失败"; } Log.i("info", ttsString); } catch (ConnectionException | RequestTimeoutException | ServiceResponseException e) { Log.e("error", e.toString()); } catch (Exception e) { Log.e("error", e.toString()); } return ttsString; } @Override protected void onPause() { mediaPlayerService.stopMyPlayer(createFilePath); super.onPause(); } }
  • 响应参数 响应类为RunTtsResponse,详见下表。调用失败处理方法请参见错误码。 表2 RunTtsResponse 参数名 是否必选 参数类型 说明 trace_id 是 String 服务内部的令牌,可用于在日志中追溯具体流程,调用失败无此字段。 在某些错误情况下可能没有此令牌字符串。 result 是 Object 调用成功时为合成语音内容,请参考表3。 调用失败时无此字段。 表3 Result 参数名 是否必选 参数类型 说明 data 是 String 合成后生成的语音数据,以Base64编码格式返回。用户如需生成音频,需要将Base64编码解码成byte数组,再保存为wav音频。
  • 请求参数 请求类为RunTtsRequest,其中包含参数类PostCustomTTSReq,该类包含两个参数text(待合成文本)和TtsConfig,详见TtsConfig。 表1 TtsConfig 参数名称 是否必选 参数类型 描述 audio_format 否 String 待合成的音频格式,可选mp3,wav等,默认wav。具体信息请参见《API参考》中语音合成章节。 pitch 否 Integer 音高,[-500,500] ,默认是0。 speed 否 Integer 语速,[-500,500] ,默认是0。 volume 否 Integer 音量,[0,100],默认是50。 sample_rate 否 String 采样率,支持“8000”、“16000”,默认“8000”。 property 否 String 特征字符串,{language}_{speaker}_{domain},默认chinese_xiaoqi_common。具体信息请参见《API参考》中语音合成章节。 伪代码 TtsConfig configbody = new TtsConfig(); configbody.setAudioFormat(TtsConfig.AudioFormatEnum.fromValue("wav")); configbody.setSampleRate(TtsConfig.SampleRateEnum.fromValue("8000")); configbody.setProperty(TtsConfig.PropertyEnum.fromValue("chinese_huaxiaomei_common")); RunTtsRequest request = new RunTtsRequest(); PostCustomTTSReq body = new PostCustomTTSReq(); body.withConfig(configbody); if (!StringUtils.isEmpty(text.getText().toString())) { body.withText(text.getText().toString()); } else { body.withText("请输入合成文本"); } request.withBody(body); return request;
  • 初始化Client 初始化SisClient,详细信息如下。 配置客户端连接参数。 默认配置 // 使用默认配置 HttpConfig config = HttpConfig.getDefaultHttpConfig(); 网络代理(可选) // 根据需要配置网络代理,网络代理默认的协议为 `http` 协议 config.withProxyHost("proxy.huaweicloud.com") .withProxyPort(8080) .withProxyUsername("test") .withProxyPassword("test"); 超时配置(可选) // 默认连接超时时间为60秒,可根据需要调整 config.withTimeout(60); SSL配置(可选) // 根据需要配置是否跳过SSL证书验证 config.withIgnoreSSLVerification(true); 配置认证信息。 配置AK、SK、project_id信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。 使用永久AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); 使用临时AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withSecurityToken(securityToken) .withProjectId(projectId) 认证参数说明: ak、sk:访问密钥信息,获取方法请参考AK/SK认证。 projectId:华为云项目ID,获取方法请参考获取项目ID。。 securityToken:采用临时AK、SK 认证场景下的安全票据,可以通过token获取或者通过委托授权获取。 初始化客户端(region和指定云服务enddpoint二选一即可)。 指定region方式(强烈推荐) // 初始化客户端认证信息,使用当前客户端初始化方式可不填 projectId/domainId,以初始化 BasicCredentials 为例 BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk); // 初始化指定云服务的客户端 {Service}Client ,以初始化 Region 级服务SIS的 SisClient 为例 SisClient client = SisClient.newBuilder() .withHttpConfig(config) .withCredential(basicCredentials) .withRegion(SisRegion.valueOf("cn-north-4")) .build(); 指定云服务endpoint方式(可选) // 指定终端节点,以SIS服务北京四的 endpoint 为例 String endpoint = "https://sis-ext.cn-north-4.myhuaweicloud.com"; // 初始化客户端认证信息,需要填写相应 projectId/domainId,以初始化 BasicCredentials 为例 BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); // 初始化指定云服务的客户端 {Service}Client ,以初始化 Region 级服务SIS的 CbsClient 为例 SisClient client = SisClient.newBuilder() .withHttpConfig(config) .withCredential(basicCredentials) .withEndpoint(endpoint) .build(); endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点。
  • 环境毒性(Environmental Toxicity) Bioconcentration Factors: 生物浓缩系数(BFC)。生物体内某种化合物的浓度同水中该物质的浓度比值,单位为log10(L/kg)。 IGC50: 48 hour Tetrahymena pyriformis IGC50(50% Inhibition Growth Concentration),导致50% Tetrahymena pyriformis生长抑制,在48小时后的化学物质浓度。单位为−log10[(mg/L)/(1000*MW)]。 LC50FM: 96 hour fathead minnow LC50,导致50% fathead minnow死亡,在96小时后的化学物质浓度。单位为−log10[(mg/L)/(1000*MW)]。 LC50DM: 48 hour Daphnia magna LC50,导致50% Daphnia magna死亡,在48小时后的化学物质浓度。单位为−log10[(mg/L)/(1000*MW)]。
  • 毒效团(Toxicophore Rules) Acute Toxicity Rule: 有20个子结构,含有该子结构可能在口服给药期间引起急性毒性。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 Genotoxic Carcinogenicity Rule: 117个子结构,含有该子结构可能通过遗传毒性引起致癌性或者致突变性。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 NonGenotoxic Carcinogenicity Rule: 23个子结构,含有该子结构可能通过非遗传毒性引起致癌性或者致突变性。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 Skin Sensitization Rule: 155个子结构,含有该子结构可能会导致皮肤损伤。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 Aquatic Toxicity Rule: 99个子结构,含有该子结构可能会对液体(包括水)造成毒性。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 NonBiodegradable Rule: 19个子结构,含有该子结构可能会不可生物降解。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 SureChEMBL Rule: 164个子结构,含有该子结构可能会具有不好的药物化学结构。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。 FAF-Drugs4 Rule: 154个子结构,含有该子结构可能会有毒性。 结果解释:数值代表有多少个子结构匹配此数据库,可以通过DETAIL查看所匹配的子结构特征。
  • 分布(Distribution) PPB: Plasma protein binding,血浆蛋白结合度。结合度的多少会影响药物的渗透情况。 结果解释:结合度小于90%比较合适。 VD: Volume Distribution,体积分布,单位为L/kg。 结果解释:VD值在0.04~20L/kg之间较好。 BBB Penetration: blood–brain barrier Penetration,血脑屏障。作用于中枢神经系统的药物需要穿过血脑屏障 (BBB) 才能达到其分子靶点。相反,对于具有外围靶点的药物,不需要BBB渗透以避免中枢神经系统副作用,单位为cm/s。logBB 大于-1为(BBB+), logBB小于等于-1为(BBB-),数值在0~1之间。 结果解释:预测值的范围在0~1之间。 Fu: The fraction unbound in plasms,未结合血清蛋白的比例。药物与血清蛋白的结合程度越高,渗透性越差。 结果解释:未结合比例大于等于5%效果较好。
  • Tox21通路(Tox21 Pathway) NR-AR: Androgen receptor,雄激素受体。在AR依赖性前列腺癌和其他相关雄激素相关疾病中其关键作用,内分泌干扰物与AR的相互作用,会破坏正常的内分泌功能,因此需要了解化学物质对ER信号通路的影响。0为AR无活性,1为AR有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-AR-LBD: 雄激素受体配体结合区。0为AR-LBD无活性,1为AR-LBD有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-AhR: The Aryl hydrocarbon Receptor,芳香烃受体。AhR是一种配体激活性转录因子。当与多环芳烃、卤代芳烃等配体结合后,可调控一系列基因的表达。0为AhR无活性,1为AhR有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-Aromatase: Aromatase,芳香化酶,是雌激素生物合成的关键酶。0为Aromatase无活性,1为Aromatase有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-ER: Estrogen receptor,雌激素受体。在发育和新城代谢中起重要作用,内分泌干扰物与ER的相互作用,会破坏正常的内分泌功能,因此需要了解化学物质对ER信号通路的影响,0为Estrogen receptor无活性,1为Estrogen receptor有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-ER-LBD: 雌激素受体配体结合区。0为ER-LBD无活性,1为ER-LBD有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 NR-PPAR-gamma: peroxisome proliferator-activated receptors PPAR,过氧化物酶体增殖物激活受体。PPAR是一类由配体激活的核转录因子,PPAR超家族有3个亚型:即PPAR-α、 PPAR-δ(又称PPAR-β或NUC-1)和PPAR-γ,分别由不同的基因编码,PPAR-γ受体(格列酮受体)。参与调节糖脂代谢。0为PPAR-gamma无活性,1为PPAR-gamma有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 SR-ARE: antioxidant response element ARE,抗氧化反应元件。ARE与Nrf2结合,启动下游大量的抗氧化酶基因的转录。0为ARE无活性,1为ARE有活性。数值在0~1之间。 结果解释:预测值的范围在0~1之间。 SR-ATAD5: ATPase family AAA domain-containing protein 5,三磷酸腺苷酶家族蛋白5。ATAD5会随着各种类型的DNA损伤而在蛋白质水平上增长。0为ATAD5无活性,1为ATAD5有活性,数值在0~1之间。 结果解释:预测值的范围在0~1之间。 SR-HSE: Heat shock factor,热激蛋白。HSE是一类功能性相关蛋白质,当细胞受到升高温度或其他胁迫时它们的表达就会增长。0为HSE无活性,1为HSE有活性,数值在0~1之间。 结果解释:预测值的范围在0~1之间。 SR-MMP: Mitochondrial membrane potential,线粒体膜电位。线粒体是动植物细胞生成ATP的主要地点,是促进细胞能量转换、参与细胞凋亡的重要细胞器。 线粒体在产生能量时会将电化学势能储存于线粒体内膜,在内膜两侧,若质子及其他离子浓度的不对称分布就会形成线粒体膜电位,即MMP,测量活细胞中的MMP通常用于评估化学物质对线粒体功能的影响。0为MMP无活性,1为MMP有活性,数值在0~1之间。 结果解释:预测值的范围在0~1之间。 SR-p53: p53,一种肿瘤抑制因子,控制细胞周期的启动。在所有恶性肿瘤中,50%以上会出现该基因的突变。0为p53无活性,1为p53有活性,数值在0~1之间。 结果解释:预测值的范围在0~1之间。
  • 吸收(Absorption) Caco-2 Permeability: 人体结肠腺癌细胞系(Caco-2)用来估计药物渗透性。单位为Log cm/s。 结果解释:大于-5.15 log cm/s代表具有较好的渗透性。 MDCK Permeability: MDCK细胞的表观渗透系数Papp用来估计药物进入人体的吸收效率。单位为cm/s。 结果解释:大于20 x 10-6cm/s代表具有较好的渗透性,2~20 x 10-6cm/s具有一般渗透性,小于2 x 10-6cm/s具有较差的渗透性。 Pgp-inhibitor: Pgp-inhibitor,Pgp抑制。0为非Pgp抑制,1为Pgp抑制。 结果解释:预测值的范围在0~1之间。 Pgp-substrate: Pgp-substrate,Pgp基质。0为非Pgp基质,1为Pgp基质。 结果解释:预测值的范围在0~1之间。 HIA: Human intestinal absorption,人体肠道吸收指标。HIA大于30%代表具有较好的吸收性(HIA+),小于30%为(HIA-)。 结果解释:预测值的范围在0~1之间。 F20%: The human oral bioavailability 20%,人体口服生物利用度。大于20%为(F20%+),小于20%为(F20%-)。 结果解释:预测值的范围在0~1之间。 F30%: The human oral bioavailability 30%,人体口服生物利用度。大于30%为(F30%+),小于30%为(F30%-)。 结果解释:预测值的范围在0~1之间。
  • 代谢(Metabolism) Metabolism 药物代谢反应过程可以分为两大类:第一阶段(氧化反应),第二阶段(共轭反应),人类细胞色素P450家族与第一阶段的氧化反应有关,其中1A2、3A4、2C9同工酶尤为重要,大部分集中在肝脏。0为非抑制剂/非基质,1为抑制剂/基质,数值范围在0~1之间。 结果解释:预测值的范围在0~1之间。 CYP1A2 inhibitor 细胞色素P450 1A2亚型抑制剂,0为非抑制剂,1为抑制剂。 结果解释:预测值的范围在0~1之间。 CYP2C9 inhibitor 细胞色素P450 2C9亚型抑制剂,0为非抑制剂,1为抑制剂。 结果解释:预测值的范围在0~1之间. CYP3A4 inhibitor 细胞色素P450 3A4亚型抑制剂,0为非抑制剂,1为抑制剂。 结果解释:预测值的范围在0~1之间。 CYP2C19 inhibitor 细胞色素P450 2C19亚型抑制剂,0为非抑制剂,1为抑制剂。 结果解释:预测值的范围在0~1之间。
  • 修订记录 表1 修订记录 文档版本 发布日期 修改说明 04 2024-04-11 第四次正式发布。 新增: 支持分子搜索。 支持自定义数据库。 修改: 分子优化。 靶点口袋发现。 靶点口袋分子设计。 自由能微扰。 分子属性预测。 合成路径规划。 03 2023-12-30 第三次正式发布。 新增: 支持小分子聚类。 支持卡片视图,同时查看多个小分子。 修改: 导入应用的数量限制。 分子属性上限。 分子对接计费规则。 02 2023-11-02 第二次正式发布。 新增 靶点口袋发现 靶点口袋分子设计 AI模型 修改 分子对接 分子优化 自由能微扰 分子属性预测 01 2023-08-10 第一次正式发布。 父主题: 用户指南(盘古辅助制药)
  • 操作步骤 登录华为云管理控制台,鼠标指向页面右上角的用户名,在下拉列表中单击“我的凭证”。 图1 我的凭证入口 在“我的凭证”页面中选择“访问密钥”页签。单击“新增访问密钥”,按操作指引获取认证账账号的AK/SK,请妥善保管AK/SK信息。 图2 访问密钥 每个用户仅允许新增两个访问密钥。 为保证访问密钥的安全,访问密钥仅在初次生成时自动下载,后续不可再次通过管理控制台页面获取。请在生成后妥善保管。
  • 步骤4:创建应用 在“项目管理”页面“工具”页签中,单击“新建应用”。 填写应用的基本信息。 “名称”填写fastqc,“版本”填写v0.11.5.2。“短描述”、“描述”、“标签”可选填。 图2 填写基本信息 选择镜像。 单击“选择镜像”,在“ 自定义镜像 ”列表中选择fastqc镜像和镜像版本。 依据FastQC命令说明填写镜像启动命令。 镜像启动命令需要引用输入、输出参数中的变量,并以大括号扩起,以$符号进行引用。 fastqc软件输入参数填写为input-file、threads,输出参数为output-dir,则镜像启动命令如下所示。 使用-t命令,指定运行所需的线程数量。-o命令,指定存放输出结果的文件夹。输入文件夹已在填写参数时指定。 fastqc -t ${threads} -o ${output-dir} ${input-file} 选择“X86”CPU架构,CPU需求建议0.2起。GPU类型选择“无”。 按需填写内存大小,单位为GB。FastQC运行中所需内存大小依赖于输入数据大小,建议至少1GB。 图3 CPU、内存、GPU 填写参数。 通过阅读FastQC命令说明,了解命令。 图4 FastQC命令 填写所需的输入参数。 图5 输入参数 填写所需的输出参数。 因镜像启动命令中指定了输出参数,设置输出参数时,需勾选“必传”,并填写“默认值”。例如,输出结果默认存放在fastqc_output文件夹中。 图6 输出参数 单击“立即创建”,完成fastqc应用的创建。 创建完成后的应用,将显示在应用列表中,您可以使用该应用创建分析作业。
  • 步骤2:制作镜像 方法1:直接下载官方的FastQC镜像。 执行如下命令下载FastQC镜像。 docker pull biocontainers/fastqc:v0.11.5 方法2:通过Dockerfile制作FastQC镜像。 执行vi Dockerfile命令,进入Dockerfile文件中,编写文件。 FROM ubuntu:16.04 # FastQC依赖java运行,需安装java环境。安装执行下载、解压缩的软件包 RUN apt-get update && apt-get upgrade -y \ && apt-get install -y default-jre perl wget zip # 下载FastQC,解压缩,设置FastQC可执行权限 RUN wget https://www.bioinformatics.babraham.ac.uk/projects/fastqc/fastqc_v0.11.5.zip \ && unzip fastqc_v0.11.5.zip \ && rm fastqc_v0.11.5.zip \ && chmod +x /FastQC/fastqc # 将FastQC添加到环境变量中 ENV PATH "/FastQC:$PATH 按Esc键,并执行:wq退出Dockerfile。 制作镜像。 docker build -t fastqc:v0.11.5 . 详细的Dockerfile指令请参见Dockerfile参考。
  • 步骤1:搭建Docker环境 搭建Docker环境,您可以任选以下两种方式搭建Docker环境。 使用自己的电脑搭建Docker环境。 使用华为云弹性 云服务器ECS 搭建Docker环境。 本示例中使用华为云弹性服务器E CS ,并通过ECS搭建Docker环境。在创建ECS时,可以选择ECS的操作系统。例如,在Linux操作系统下,可以使用如下命令快速安装容器引擎。 curl -fsSL get.docker.com -o get-docker.sh sh get-docker.sh 检查安装结果。 执行docker --version命令,如果显示如下类似信息,表示Docker安装成功。 图1 Docker安装成功
  • 获取NGS作业配置文件 编写NGS作业配置文件有两种方式,建议您使用第一种,通过获取已经执行成功的NGS配置文件,并在该配置文件基础上进行修改,得到可以用于批量执行NGS的配置文件。本示例介绍使用方法一获取配置文件的方法。 方式一 使用 EIHealth 平台完成NGS流程的搭建,并执行成功,然后在“分析作业”页面导出作业信息.yaml文件。 方式二 使用命令行工具完成NGS流程的搭建,进而获取相应的配置文件。详细的操作请参见命令行工具。 使用switch命令进入NGS流程所在的项目。 例如,使用health switch project ngs-project命令进入到名为ngs-project的项目中。 使用health get job命令获取该项目下所有的作业信息。 查询NGS作业对应的job-id,使用health get job job-id命令获取NGS作业的信息。使用health get workflow命令查询NGS作业对应的workflow-id。获取到的作业信息如图1所示。 图1 NGS作业信息 health get job -s命令获取启动分析作业的模板。依据模板要求,将步骤3中获取到的NGS作业信息和workflow-id填充至模板中,修改好的配置文件示例请参见NGS配置文件示例。 请将该模板保存为.yaml格式至本地,并在本地完成模板修改。例如,命名为ngs.yaml。
  • 编写执行脚本并提交作业 运行分析作业时,流程中的每一个应用称之为一个任务(Task),通过循环读取Task的输入数据,可以实现作业的批量执行。 例如,您可以在本地创建.bat格式的批处理文件,执行该脚本即可批量运行NGS分析作业。 @echo off set list="task-1-fastp.fastq-file1=asset0331:/ngs/NA12878_0.R1.fastq.gz;task-1-fastp.fastq-file2=asset0331:/ngs/NA12878_0.R2.fastq.gz" "task-1-fastp.fastq-file1=asset0331:/ngs/NA12878_0.R1.fastq.gz;task-1-fastp.fastq-file2=asset0331:/ngs/NA12878_0.R2.fastq.gz" health switch project ngs-project for %%a in (%list%) do ( echo %%a health create job -y D:\test\ngs.yaml -i %%a echo/ ) pause 图2 批处理文件说明 如果执行NGS批量任务时需要变更不同的原始数据、参考基因序列、测序平台、文件前缀等,请参考上述批处理文件示例,将需要变更的数据补充完整。 .bat批处理文件需要和命令行工具放在同一路径下,同时,命令行工具需为登录状态。
  • NGS配置文件示例 NGS作业由十个Task执行完成,本示例以fastp和bwa-mem两个Task为例,介绍.yaml文件填写规则,完整的NGS配置文件请参考本示例以及获取NGS作业配置文件章节得到的作业信息和模板填写。 job: name: ngs-test description '' priority: 0 timeout: 1440 output_dir: '' workflow_id: ngs-workflow::1.0.0::ngs-project tasks: - task_name: task-1-fastp inputs: - name: fastq-file1 values: - 'ngs-project:/ngs/NA12878_0.R1.fastq.gz' inputs: - name: fastq-file2 values: - 'ngs-project:/ngs/NA12878_0.R2.fastq.gz' resources: cpu: 0.1C memory: 0.1G gpu_type: '' gpu: '0' - task_name: task-2-bwa-mem inputs: - name: fq-file1 values: - '${task-1-fastp.fq-file1}' - name: fq-file2 values: - '${task-1-fastp.fq-file2}' - name: ref-file values: - 'ngs-project:/ngs/GCA_000001405.15_GRCh38_no_alt_plus_hs38d1_analysis_set.fna' - name: seq-platform values: - 'MGI' - name: sample-id values: - 'NA12878' resources: cpu: 16C memory: 10G gpu_type: '' gpu: '0' ...
  • 公共响应参数 公共响应参数如表 公共响应参数所示。 表1 公共响应参数 参数名 说明 Content-Length 响应消息体的字节长度,单位为Byte。 Date 系统响应的时间。 Content-type 发送的实体的MIME类型。 Upgrade 发送WebSocket握手请求时,响应消息包含该头域,内容为Websocket。 Connection 发送WebSocket握手请求时,响应消息包含该头域,内容为Upgrade。 Sec-WebSocket-Accept 结合Sec-WebSocket-Key提供基本的防护,比如恶意的连接,或者无意的连接。 父主题: 附录
  • 示例 { "command": "START", "text": "欢迎使用语音云服务。", "config": { "audio_format": "pcm", "sample_rate": "8000", "property": "chinese_xiaoyan_common", "speed": 10, "pitch": 10, "volume": 60 } }
  • 请求消息 表1 参数说明 名称 参数类型 是否必选 说明 command String 是 需设置为START,表示开始识别请求。 text String 是 待合成的文本,chinese_huaxiaomei_common,chinese_huaxiaofei_common,chinese_huaxiaolong_common,chinese_huaxiaorui_common发音人支持长度不大于10000字符的文本,其他发音人支持长度不大于500字符的文本。 config Object 否 配置信息。请参考表2。 表2 config数据结构 名称 参数类型 是否必选 说明 audio_format String 否 语音格式头:pcm、alaw、ulaw、mp3。 默认:pcm sample_rate String 否 采样率:16000、8000赫兹。 默认:8000 property String 否 可参考表3和表4。 默认:chinese_xiaoyan_common 实时语音合成和语音合成属于同一种资源,按次计费。实时语音合成普通发音人,每100字计一次。精品发音人每50字计一次。 speed Integer 否 语速。 取值范围:-500~500 默认值:0 pitch Integer 否 音高。 取值范围:-500~500 默认值:0 volume Integer 否 音量。 取值范围:0~100 默认值:50 subtitle String 否 是否生成时间戳信息,不使用则不填写。 取值范围: “word_level”:文本级别时间戳 “phoneme_level”:音素级别时间戳 注:chinese_huaxiaomei_common、chinese_huaxiaofei_common支持该功能,其他property暂不支持 表3 普通发音人property取值范围 名称 property取值 类型 使用场景 支持采样率(Hz) 支持audio_format 小琪 chinese_xiaoqi_common 标准女声 客服 8k/16k pcm、alaw、ulaw 小宇 chinese_xiaoyu_common 标准男声 电销 8k/16k pcm、alaw、ulaw 小燕 chinese_xiaoyan_common 温柔女声 文学 8k/16k pcm、alaw、ulaw 小王 chinese_xiaowang_common 童声 童声 8k/16k pcm、alaw、ulaw 表4 精品发音人property取值范围 名称 property取值 类型 使用场景 支持采样率(Hz) 支持audio_format 华小美 chinese_huaxiaomei_common 温柔女声 客服 8k/16k pcm、mp3 华小飞 chinese_huaxiaofei_common 朝气男声 客服 8k/16k pcm、mp3 华小汝 chinese_huaxiaoru_common 柔美女声 中英混合 8k/16k pcm 华小涵 chinese_huaxiaohan_common 知性女声 中英混合 8k/16k pcm 华小蕊 chinese_huaxiaorui_common 知性女声 中英混合 16k pcm、mp3 华小龙 chinese_huaxiaolong_common 朝气男声 中英混合 16k pcm、mp3 华小珍 chinese_huaxiaozhen_common 温柔女声 中英混合 8k/16k pcm alvin english_alvin_common 成熟男声 纯英文 8k/16k pcm amy english_amy_common 成熟女声 纯英文 8k/16k pcm
共100000条