AICloudVprintIntent (DUI Lite SDK

java.lang.Object
- com.aispeech.export.intent.AICloudVprintIntent

public class AICloudVprintIntent
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AICloudVprintIntent.Audio` 音频的格式 "audio":{ "audioType": "wav", // 必选 "sampleRate": 16000, // 必选 "channel": 1, // 必选 "sampleBytes": 2 // 必选 }
`static class`	`AICloudVprintIntent.Builder`
`static class`	`AICloudVprintIntent.Env`

Constructor Summary

Constructors
Constructor and Description

AICloudVprintIntent()

Constructors
Constructor and Description
`AICloudVprintIntent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAliasKey()` 获取当前云端声纹使用的资源版本
`org.json.JSONObject`	`getApp()`
`float`	`getAsrErrorRate()` 文本半相关语音文本结果和custom_context的字错误率的百分比阈值 [0,100]，结果向下取整，仅用于文本相关的注册和验证，默认值0
`AICloudVprintIntent.Audio`	`getAudio()`
`java.lang.String`	`getContextId()` 如果有contextId，服务端认为是同一个验证，会使用保存的cache和新的数据进行加强验证，仅用于实时验证
`java.lang.String`	`getCustomContent()` 文本（半）相关时输入的语音文本。使用文本（半）相关时必需设置
`java.lang.String`	`getDomain()` 领域（comm/aihome/aitv/aicar/aiphone/airobot/aitranson-cn-16k/aitranson-en-16k) 用于注册和实时声纹验证，注册时非必需，实时声纹验证必需设置
`java.lang.String`	`getGroupId()` users和groupId，二选一，或者2个都填（按最小集），仅用于离线声纹验证
`float`	`getMinSpeechLength()` 最小有效音频长度，单位秒,默认注册声纹，离线验证0.4s,验证声纹sti-sr 1s， lti-sr 500ms
`java.lang.String`	`getOrganization()` 用户所在的公司，项目,非必需
`java.lang.String`	`getRequestId()` 标记一次请求，可选, 如果不存在则服务端会生成一个非必需
`int`	`getTopN()` 1:N按照score排序,输出前n个得分,若不配置该选项,会在result字段中返回所有得分,开启该选项后会在topN字段中返回得分排名靠前的最多N个得分.仅用于离线验证
`java.lang.String`	`getUserId()` 声纹ID，用户ID在系统中应该是唯一的注册时非必需，不设置服务端会生成一个注销时必须设置仅用于注册和注销
`java.util.List<java.lang.String>`	`getUsers()` 要对比的用户id列表。若users列表为空,择选取organization所有的id做1：N比对，仅用于验证
`java.lang.String`	`getWavFilepath()` 用于注册和验证声纹的音频文件路径，必需设置
`boolean`	`isEnableSpeakerAntiSpoofing()` 语音活体检测，仅用于离线验证
`boolean`	`isEnableVad()` 文本无关vad开关
`boolean`	`isEnhanceRegister()` 注册增强，仅用于注册
`boolean`	`isSkip_saving()` 为true不保存音频，默认false，非必需设置
`void`	`setAliasKey(java.lang.String aliasKey)` 设置当前云端声纹使用的资源版本，可设置为prod
`void`	`setAsrErrorRate(float asrErrorRate)` 文本半相关语音文本结果和custom_context的字错误率的百分比阈值 [0,100]，结果向下取整，仅用于文本相关的注册和验证，默认值0
`void`	`setContextId(java.lang.String contextId)` 如果有contextId，服务端认为是同一个验证，会使用保存的cache和新的数据进行加强验证，仅用于实时验证
`void`	`setCustomContent(java.lang.String customContent)` 文本（半）相关时输入的语音文本。使用文本（半）相关时必需设置
`void`	`setDomain(java.lang.String domain)` 领域（comm/aihome/aitv/aicar/aiphone/airobot/aitranson-cn-16k/aitranson-en-16k) 用于注册和实时声纹验证，注册时非必需，实时声纹验证必需设置
`void`	`setEnableSpeakerAntiSpoofing(boolean enableSpeakerAntiSpoofing)` 语音活体检测，仅用于离线验证
`void`	`setEnableVad(boolean enableVad)` 文本无关vad开关，默认为true
`void`	`setEnhanceRegister(boolean enhanceRegister)` 注册增强，仅用于注册，默认false
`void`	`setGroupId(java.lang.String groupId)` users和groupId，二选一，或者2个都填（按最小集），仅用于离线声纹验证
`void`	`setMinSpeechLength(float minSpeechLength)` 最小有效音频长度，单位秒,默认注册声纹，离线验证0.4s,验证声纹sti-sr 1s， lti-sr 500ms
`void`	`setOrganization(java.lang.String organization)` 用户所在的公司，项目,非必需
`void`	`setRequestId(java.lang.String requestId)` 标记一次请求，可选, 如果不存在则服务端会生成一个非必需
`void`	`setSkip_saving(boolean skip_saving)` 为true不保存音频，默认false，非必需设置
`void`	`setTopN(int topN)` 1:N按照score排序,输出前n个得分,若不配置该选项,会在result字段中返回所有得分,开启该选项后会在topN字段中返回得分排名靠前的最多N个得分.仅用于离线验证
`void`	`setUserId(java.lang.String userId)` 声纹ID，用户ID在系统中应该是唯一的注册时非必需，不设置服务端会生成一个注销时必须设置仅用于注册和注销
`void`	`setUsers(java.util.List<java.lang.String> users)` 要对比的用户id列表。若users列表为空,择选取organization所有的id做1：N比对，仅用于验证
`void`	`setWavFilepath(java.lang.String wavFilepath)` 用于注册和验证声纹的音频文件路径，必需设置
`org.json.JSONObject`	`toJson()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AICloudVprintIntent
```
public AICloudVprintIntent()
```
- Method Detail
  - getApp
```
public org.json.JSONObject getApp()
```
  - getAudio
```
public AICloudVprintIntent.Audio getAudio()
```
  - getContextId
```
public java.lang.String getContextId()
```
    如果有contextId，服务端认为是同一个验证，会使用保存的cache和新的数据进行加强验证，仅用于实时验证
    
    Returns:
    
    返回contextID
  - setContextId
```
public void setContextId(java.lang.String contextId)
```
    如果有contextId，服务端认为是同一个验证，会使用保存的cache和新的数据进行加强验证，仅用于实时验证
    
    Parameters:
    
    contextId - 用于服务器判断是同一个验证
  - getTopN
```
public int getTopN()
```
    1:N按照score排序,输出前n个得分,若不配置该选项,会在result字段中返回所有得分,开启该选项后会在topN字段中返回得分排名靠前的最多N个得分.仅用于离线验证
    
    Returns:
    
    返回前n个得分
  - setTopN
```
public void setTopN(int topN)
```
    1:N按照score排序,输出前n个得分,若不配置该选项,会在result字段中返回所有得分,开启该选项后会在topN字段中返回得分排名靠前的最多N个得分.仅用于离线验证
    
    Parameters:
    
    topN - 设置前N个得分
  - isEnableSpeakerAntiSpoofing
```
public boolean isEnableSpeakerAntiSpoofing()
```
    语音活体检测，仅用于离线验证
    
    Returns:
    
    活体检测
  - setEnableSpeakerAntiSpoofing
```
public void setEnableSpeakerAntiSpoofing(boolean enableSpeakerAntiSpoofing)
```
    语音活体检测，仅用于离线验证
    
    Parameters:
    
    enableSpeakerAntiSpoofing - 语音活体检测
  - getGroupId
```
public java.lang.String getGroupId()
```
    users和groupId，二选一，或者2个都填（按最小集），仅用于离线声纹验证
    
    Returns:
    
    groupID
  - setGroupId
```
public void setGroupId(java.lang.String groupId)
```
    users和groupId，二选一，或者2个都填（按最小集），仅用于离线声纹验证
    
    Parameters:
    
    groupId - 设置groupID
  - getUsers
```
public java.util.List<java.lang.String> getUsers()
```
    要对比的用户id列表。若users列表为空,择选取organization所有的id做1：N比对，仅用于验证
    
    Returns:
    
    用户列表返回
  - setUsers
```
public void setUsers(java.util.List<java.lang.String> users)
```
    要对比的用户id列表。若users列表为空,择选取organization所有的id做1：N比对，仅用于验证
    
    Parameters:
    
    users - 设置用户列表
  - getRequestId
```
public java.lang.String getRequestId()
```
    标记一次请求，可选, 如果不存在则服务端会生成一个非必需
    
    Returns:
    
    请求ID
  - setRequestId
```
public void setRequestId(java.lang.String requestId)
```
    标记一次请求，可选, 如果不存在则服务端会生成一个非必需
    
    Parameters:
    
    requestId - 请求ID
  - getUserId
```
public java.lang.String getUserId()
```
    声纹ID，用户ID在系统中应该是唯一的注册时非必需，不设置服务端会生成一个注销时必须设置仅用于注册和注销
    
    Returns:
    
    用户ID
  - setUserId
```
public void setUserId(java.lang.String userId)
```
    声纹ID，用户ID在系统中应该是唯一的注册时非必需，不设置服务端会生成一个注销时必须设置仅用于注册和注销
    
    Parameters:
    
    userId - 用户ID
  - getOrganization
```
public java.lang.String getOrganization()
```
    用户所在的公司，项目,非必需
    
    Returns:
    
    用户所在的公司，项目
  - setOrganization
```
public void setOrganization(java.lang.String organization)
```
    用户所在的公司，项目,非必需
    
    Parameters:
    
    organization - 用户所在的公司，项目
  - getDomain
```
public java.lang.String getDomain()
```
    领域（comm/aihome/aitv/aicar/aiphone/airobot/aitranson-cn-16k/aitranson-en-16k) 用于注册和实时声纹验证，注册时非必需，实时声纹验证必需设置
    
    Returns:
    
    domain 领域
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    领域（comm/aihome/aitv/aicar/aiphone/airobot/aitranson-cn-16k/aitranson-en-16k) 用于注册和实时声纹验证，注册时非必需，实时声纹验证必需设置
    
    Parameters:
    
    domain - 领域
  - isSkip_saving
```
public boolean isSkip_saving()
```
    为true不保存音频，默认false，非必需设置
    
    Returns:
    
    是否保存音频
  - setSkip_saving
```
public void setSkip_saving(boolean skip_saving)
```
    为true不保存音频，默认false，非必需设置
    
    Parameters:
    
    skip_saving - 是否保存音频
  - getAsrErrorRate
```
public float getAsrErrorRate()
```
    文本半相关语音文本结果和custom_context的字错误率的百分比阈值 [0,100]，结果向下取整，仅用于文本相关的注册和验证，默认值0
    
    Returns:
    
    错误率百分比阈值
  - setAsrErrorRate
```
public void setAsrErrorRate(float asrErrorRate)
```
    文本半相关语音文本结果和custom_context的字错误率的百分比阈值 [0,100]，结果向下取整，仅用于文本相关的注册和验证，默认值0
    
    Parameters:
    
    asrErrorRate - 错误率百分比阈值
  - getCustomContent
```
public java.lang.String getCustomContent()
```
    文本（半）相关时输入的语音文本。使用文本（半）相关时必需设置
    
    Returns:
    
    用户注册文本
  - setCustomContent
```
public void setCustomContent(java.lang.String customContent)
```
    文本（半）相关时输入的语音文本。使用文本（半）相关时必需设置
    
    Parameters:
    
    customContent - 用户注册文本
  - isEnhanceRegister
```
public boolean isEnhanceRegister()
```
    注册增强，仅用于注册
    
    Returns:
    
    当前注册是否是注册增强
  - setEnhanceRegister
```
public void setEnhanceRegister(boolean enhanceRegister)
```
    注册增强，仅用于注册，默认false
    
    Parameters:
    
    enhanceRegister - 是否是注册增强
  - getMinSpeechLength
```
public float getMinSpeechLength()
```
    最小有效音频长度，单位秒,默认注册声纹，离线验证0.4s,验证声纹sti-sr 1s， lti-sr 500ms
    
    Returns:
    
    最小有效音频长度
  - setMinSpeechLength
```
public void setMinSpeechLength(float minSpeechLength)
```
    最小有效音频长度，单位秒,默认注册声纹，离线验证0.4s,验证声纹sti-sr 1s， lti-sr 500ms
    
    Parameters:
    
    minSpeechLength - 最小有效音频长度
  - isEnableVad
```
public boolean isEnableVad()
```
    文本无关vad开关
    
    Returns:
    
    是否使用文本无关vad
  - setEnableVad
```
public void setEnableVad(boolean enableVad)
```
    文本无关vad开关，默认为true
    
    Parameters:
    
    enableVad - 文本无关是否使用vad
  - getWavFilepath
```
public java.lang.String getWavFilepath()
```
    用于注册和验证声纹的音频文件路径，必需设置
    
    Returns:
    
    设置的注册或者验证声纹的音频文件路径
  - setWavFilepath
```
public void setWavFilepath(java.lang.String wavFilepath)
```
    用于注册和验证声纹的音频文件路径，必需设置
    
    Parameters:
    
    wavFilepath - 注册和验证的声纹音频路径
  - getAliasKey
```
public java.lang.String getAliasKey()
```
    获取当前云端声纹使用的资源版本
    
    Returns:
    
    云端声纹的资源版本
  - setAliasKey
```
public void setAliasKey(java.lang.String aliasKey)
```
    设置当前云端声纹使用的资源版本，可设置为prod
    
    Parameters:
    
    aliasKey - 设置当前使用的资源版本
  - toJson
```
public org.json.JSONObject toJson()
```

Class AICloudVprintIntent

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AICloudVprintIntent

Method Detail

getApp

getAudio

getContextId

setContextId

getTopN

setTopN

isEnableSpeakerAntiSpoofing

setEnableSpeakerAntiSpoofing

getGroupId

setGroupId

getUsers

setUsers

getRequestId

setRequestId

getUserId

setUserId

getOrganization

setOrganization

getDomain

setDomain

isSkip_saving

setSkip_saving

getAsrErrorRate

setAsrErrorRate

getCustomContent

setCustomContent

isEnhanceRegister

setEnhanceRegister

getMinSpeechLength

setMinSpeechLength

isEnableVad

setEnableVad

getWavFilepath

setWavFilepath

getAliasKey

setAliasKey

toJson