Paraformer录音文件识别iOS SDK

调用步骤

连接与控制参数

通过在nui_initialize接口的parameters参数中传入一个JSON字符串来配置。

• 参数示例：以下为 JSON 字符串示例，参数未完整列出。请按实际需求在编码时补充：

  {
      "url": "wss://dashscope.aliyuncs.com/api-ws/v1/inference",
      "apikey": "st-****",
      "device_id": "my_device_id",
      "service_mode": "1"
  }

• 参数说明

  参数	类型	是否必须	说明
  url	String	是	服务地址，固定为 wss://dashscope.aliyuncs.com/api-ws/v1/inference。
  apikey	String	是	API Key。建议使用时效性短、安全性更高的临时API Key，以降低长期有效Key泄露的风险。
  service_mode	String	是	运行模式。录音文件识别固定为 "1"。
  device_id	String	是	用于标识终端用户的唯一字符串，可设为应用内用户ID或客户端生成的设备唯一标识符。此ID主要用于日志追踪和问题排查。
  debug_path	String	否	日志文件的存储路径。 此参数仅在调用nui_initialize接口时将save_log设为YES时生效。此时必须设置日志文件路径，否则将报错。 本地最多保留两个日志文件。
  max_log_file_size	int	否	设定日志文件的最大字节数。 此参数仅在调用nui_initialize接口时将save_log设为YES时生效。 默认值：104857600（100 * 1024 * 1024 字节, 即 100MiB）。
  log_track_level	int	否	控制通过日志回调（onNuiLogTrackCallback）对外发送的日志内容的过滤级别。 默认值：2。 取值范围： 0：LOG_LEVEL_VERBOSE 1：LOG_LEVEL_DEBUG 2：LOG_LEVEL_INFO 3：LOG_LEVEL_WARNING 4：LOG_LEVEL_ERROR 5：LOG_LEVEL_NONE（表示关闭此功能） 注意：log_track_level与level（通过nui_initialize接口设置）共同决定最终回调的日志。一条日志的级别数值必须同时大于或等于log_track_level和level的值，才会被回调。例如，log_track_level设为2 (INFO)，level设为3 (WARNING)，则只有WARNING及以上级别（数值>=3）的日志才会被回调。

语音识别效果参数

通过nui_set_param接口配置nl_config参数，或者通过nui_file_trans_start接口配置所有语音识别效果参数。

• 参数示例：以下为 JSON 字符串示例，参数未完整列出。请按实际需求在编码时补充：

  {
      "file_urls": [
          "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_female2.wav",
          "https://dashscope.oss-cn-beijing.aliyuncs.com/samples/audio/paraformer/hello_world_male2.wav"
      ],
      "async_request": false,
      "nls_config": {
          "model":"paraformer-v2",
          "disfluency_removal_enabled":false,
          "timestamp_alignment_enabled": false
      }
  }

• 参数说明

  参数	类型	是否必须	说明
  file_urls	array[string]	是	音视频文件转写的URL列表，支持HTTP / HTTPS协议，单次请求最多支持100个URL。 音频格式：aac、amr、avi、flac、flv、m4a、mkv、mov、mp3、mp4、mpeg、ogg、opus、wav、webm、wma、wmv 重要 由于音视频格式及其变种众多，技术上无法穷尽测试，API不能保证所有格式均能够被正确识别。请通过测试验证您所提供的文件能够获得正常的语音识别结果。 音频采样率 因模型而异： paraformer-v2 支持任意采样率 paraformer-v1 支持任意采样率 paraformer-8k-v2 仅支持8kHz采样率 paraformer-8k-v1 仅支持8kHz采样率 paraformer-mtl-v1 支持16kHz及以上采样率 音频文件大小和时长：音频文件不超过2GB；时长在12小时以内。 如果希望处理的文件超过了上述限制，可尝试对文件进行预处理以降低文件尺寸。有关文件预处理的最佳实践可以查阅预处理视频文件以提高文件转写效率（针对录音文件识别场景）。
  async_request	boolean	否	语音识别是否为异步请求。 默认值：false。 取值范围： true：异步请求 false：同步请求
  apikey	string	否	如果连接与控制参数的apikey使用的是临时API Key，可在此处进行更新，以免超时失效。
  nls_config	object	是	语音识别核心配置对象，包含模型选择、识别效果控制等关键参数。
  nls_config.model	string	是	语音识别模型。
  nls_config.language_hints	array[string]	否	指定待识别语音的语言代码。该参数仅适用于paraformer-v2模型。 默认值：["zh", "en"]。 支持的语言代码： zh: 中文 en: 英文 ja: 日语 yue: 粤语 ko: 韩语 de：德语 fr：法语 ru：俄语
  nls_config.disfluency_removal_enabled	boolean	否	是否过滤语气词，如“嗯”、“啊”等。 默认值：false。 取值范围： true：过滤 false：不过滤
  nls_config.timestamp_alignment_enabled	boolean	否	是否启用时间戳校准功能。 默认值：false。 取值范围： true：开启 false：关闭
  nls_config.special_word_filter	object	否	指定在语音识别过程中需要处理的敏感词，并支持对不同敏感词设置不同的处理方式。 若未传入该参数，系统将启用系统内置的敏感词过滤逻辑，识别结果中与阿里云百炼敏感词表匹配的词语将被替换为等长的*。 若传入该参数，则可实现以下敏感词处理策略： 替换为 *：将匹配的敏感词替换为等长的 *； 直接过滤：将匹配的敏感词从识别结果中完全移除。 该参数的值应为一个 JSON Object，其结构如下所示： { "filter_with_signed": { "word_list": ["测试"] }, "filter_with_empty": { "word_list": ["开始", "发生"] }, "system_reserved_filter": true } JSON字段说明： filter_with_signed 类型：对象。 是否必填：否。 描述：配置需替换为*的敏感词列表。识别结果中匹配的词语将被等长的 * 替代。 示例：以上述JSON为例，“帮我测试一下这段代码”的语音识别结果将会是“帮我**一下这段代码”。 内部字段： word_list: 字符串数组，列出需被替换的敏感词。 filter_with_empty 类型：对象。 是否必填：否。 描述：配置需从识别结果中移除（过滤）的敏感词列表。识别结果中匹配的词语将被完全删除。 示例：以上述JSON为例，“比赛这就要开始了吗？”的语音识别结果将会是“比赛这就要了吗”。 内部字段： word_list: 字符串数组，列出需被完全移除（过滤）的敏感词。 system_reserved_filter 类型：布尔值。 是否必填：否。 默认值：true。 描述：是否启用系统预置的敏感词规则。设为true时，将同时启用系统内置的敏感词过滤逻辑，识别结果中与阿里云百炼敏感词表匹配的词语将被替换为等长的*。
  nls_config.channel_id	array[integer]	否	指定在多音轨文件中需要进行语音识别的音轨索引，以List的形式给出，例如[0]表示仅识别第一条音轨，[0, 1]表示同时识别前两条音轨。 默认值：[0]
  nls_config.diarization_enabled	boolean	否	自动说话人分离，默认关闭。 仅适用于单声道音频，多声道音频不支持说话人分离。 启用该功能后，识别结果中将显示speaker_id字段，用于区分不同说话人。 有关speaker_id的示例，请参见识别结果说明。
  nls_config.speaker_count	integer	否	说话人数量参考值。若要使用该功能，需将diarization_enabled设置为true。 默认自动判断说话人数量，如果配置此项，只能辅助算法尽量输出指定人数，无法保证一定会输出此人数。 取值范围：[2, 100]。该功能用于区分多个说话人，因此最少需要设置2。
  nls_config.vocabulary_id	string	否	热词词表ID，用于提升特定词汇的识别准确率。该参数适用于v2及更高版本模型。热词的使用方法请参见定制热词。
  nls_config.resources	array[object]	否	热词资源配置，用于v1版本模型。功能与vocabulary_id相同，但配置方式不同： resources 是一个对象数组，其每个元素包含 resource_id 和 resource_type 字段： resource_id：string类型，热词ID。 resource_type：string类型，取值为固定字符串“asr_phrase”。 示例： { "nls_config": { "resources": [ { "resource_id": "xxxxxxxxxxxx", "resource_type": "asr_phrase" } ] } } 热词的使用方法请参见Paraformer语音识别热词定制与管理。

NeoNui

NeoNuiSdkDelegate：监听回调

-(void)onFileTransLogTrackCallback:(NuiSdkLogLevel)level
                        logMessage:(const char *)log;

NuiCallbackEvent：事件类型