azure-docs-sdk-java/docs-ref-autogen/com.microsoft.cognitiveserv...

220 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig"
name: "DialogServiceConfig"
nameWithType: "DialogServiceConfig"
summary: "Class that defines base configurations for dialog service connector."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.close()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.close&text=close\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.enableAudioLogging()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.enableAudioLogging&text=enableAudioLogging\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.enableDictation()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.enableDictation&text=enableDictation\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromAuthorizationToken(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromAuthorizationToken&text=fromAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint(java.net.URI)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint&text=fromEndpoint\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint(java.net.URI,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint&text=fromEndpoint\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost(java.net.URI)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost&text=fromHost\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost(java.net.URI,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost&text=fromHost\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromSubscription(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromSubscription&text=fromSubscription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getAuthorizationToken()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getAuthorizationToken&text=getAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getEndpointId()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getEndpointId&text=getEndpointId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl&text=getImpl\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getOutputFormat()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getOutputFormat&text=getOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(com.microsoft.cognitiveservices.speech.PropertyId)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty&text=getProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty&text=getProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechRecognitionLanguage()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechRecognitionLanguage&text=getSpeechRecognitionLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisLanguage()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisLanguage&text=getSpeechSynthesisLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisOutputFormat()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisOutputFormat&text=getSpeechSynthesisOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisVoiceName()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisVoiceName&text=getSpeechSynthesisVoiceName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.requestWordLevelTimestamps()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.requestWordLevelTimestamps&text=requestWordLevelTimestamps\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setAuthorizationToken(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setAuthorizationToken&text=setAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setEndpointId(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setEndpointId&text=setEndpointId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setOutputFormat(com.microsoft.cognitiveservices.speech.OutputFormat)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setOutputFormat&text=setOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProfanity(com.microsoft.cognitiveservices.speech.ProfanityOption)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProfanity&text=setProfanity\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(com.microsoft.cognitiveservices.speech.PropertyId,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty&text=setProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty&text=setProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProxy(java.lang.String,int,java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProxy&text=setProxy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setServiceProperty(java.lang.String,java.lang.String,com.microsoft.cognitiveservices.speech.ServicePropertyChannel)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setServiceProperty&text=setServiceProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechRecognitionLanguage(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechRecognitionLanguage&text=setSpeechRecognitionLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisLanguage(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisLanguage&text=setSpeechSynthesisLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisOutputFormat(com.microsoft.cognitiveservices.speech.SpeechSynthesisOutputFormat)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisOutputFormat&text=setSpeechSynthesisOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisVoiceName(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisVoiceName&text=setSpeechSynthesisVoiceName\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **DialogServiceConfig**</br> extends <xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" /></br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.DialogServiceConfig(long)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.DialogServiceConfig(long handleValue)"
name: "DialogServiceConfig(long handleValue)"
nameWithType: "DialogServiceConfig.DialogServiceConfig(long handleValue)"
summary: "Creates an instance of dialog service config."
modifiers:
- "protected"
parameters:
- description: "The native handle"
name: "handleValue"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected DialogServiceConfig(long handleValue)"
desc: "Creates an instance of dialog service config."
methods:
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.close()"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.close()"
name: "close()"
nameWithType: "DialogServiceConfig.close()"
summary: "Dispose of associated resources."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.close()"
syntax: "public void close()"
desc: "Dispose of associated resources."
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getImpl()"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getImpl()"
name: "getImpl()"
nameWithType: "DialogServiceConfig.getImpl()"
summary: "Returns the dialog service configuration."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl()"
syntax: "public SafeHandle getImpl()"
desc: "Returns the dialog service configuration."
returns:
description: "The implementation of the config."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getLanguage()"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getLanguage()"
name: "getLanguage()"
nameWithType: "DialogServiceConfig.getLanguage()"
summary: "Gets the language"
syntax: "public String getLanguage()"
desc: "Gets the language"
returns:
description: "Returns the language."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getProperty(com.microsoft.cognitiveservices.speech.PropertyId)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getProperty(PropertyId id)"
name: "getProperty(PropertyId id)"
nameWithType: "DialogServiceConfig.getProperty(PropertyId id)"
summary: "Gets the property by property<wbr>Id."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(com.microsoft.cognitiveservices.speech.PropertyId)"
parameters:
- description: "PropertyId of the property."
name: "id"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.PropertyId?alt=com.microsoft.cognitiveservices.speech.PropertyId&text=PropertyId\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String getProperty(PropertyId id)"
desc: "Gets the property by propertyId."
returns:
description: "The value."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getProperty(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.getProperty(String name)"
name: "getProperty(String name)"
nameWithType: "DialogServiceConfig.getProperty(String name)"
summary: "Gets a named property as value."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(java.lang.String)"
parameters:
- description: "the name of the property."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String getProperty(String name)"
desc: "Gets a named property as value."
returns:
description: "The value."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setLanguage(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setLanguage(String value)"
name: "setLanguage(String value)"
nameWithType: "DialogServiceConfig.setLanguage(String value)"
summary: "Sets the language"
parameters:
- description: "the language identifier in BCP-47 format."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setLanguage(String value)"
desc: "Sets the language"
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProperty(com.microsoft.cognitiveservices.speech.PropertyId,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProperty(PropertyId id, String value)"
name: "setProperty(PropertyId id, String value)"
nameWithType: "DialogServiceConfig.setProperty(PropertyId id, String value)"
summary: "Sets the property by property<wbr>Id."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(com.microsoft.cognitiveservices.speech.PropertyId,java.lang.String)"
parameters:
- description: "PropertyId of the property."
name: "id"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.PropertyId?alt=com.microsoft.cognitiveservices.speech.PropertyId&text=PropertyId\" data-throw-if-not-resolved=\"False\" />"
- description: "The value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setProperty(PropertyId id, String value)"
desc: "Sets the property by propertyId."
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProperty(java.lang.String,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProperty(String name, String value)"
name: "setProperty(String name, String value)"
nameWithType: "DialogServiceConfig.setProperty(String name, String value)"
summary: "Sets a named property as value."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(java.lang.String,java.lang.String)"
parameters:
- description: "the name of the property."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setProperty(String name, String value)"
desc: "Sets a named property as value."
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProxy(java.lang.String,int,java.lang.String,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)"
name: "setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)"
nameWithType: "DialogServiceConfig.setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)"
summary: "Sets proxy configuration Note: Proxy functionality is not available on macOS."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.setProxy(java.lang.String,int,java.lang.String,java.lang.String)"
parameters:
- description: "the host name of the proxy server, without the protocol scheme (http://)"
name: "proxyHostName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the port number of the proxy server."
name: "proxyPort"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "the user name of the proxy server. Use empty string if no user name is needed."
name: "proxyUserName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the password of the proxy server. Use empty string if no user password is needed."
name: "proxyPassword"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)"
desc: "Sets proxy configuration Note: Proxy functionality is not available on macOS. This function will have no effect on this platform."
- uid: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setServiceProperty(java.lang.String,java.lang.String,com.microsoft.cognitiveservices.speech.ServicePropertyChannel)"
fullName: "com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig.setServiceProperty(String name, String value, ServicePropertyChannel channel)"
name: "setServiceProperty(String name, String value, ServicePropertyChannel channel)"
nameWithType: "DialogServiceConfig.setServiceProperty(String name, String value, ServicePropertyChannel channel)"
summary: "Sets a property value that will be passed to service using the specified channel."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.setServiceProperty(java.lang.String,java.lang.String,com.microsoft.cognitiveservices.speech.ServicePropertyChannel)"
parameters:
- description: "the property name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the property value."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the channel used to pass the specified property to service."
name: "channel"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.ServicePropertyChannel?alt=com.microsoft.cognitiveservices.speech.ServicePropertyChannel&text=ServicePropertyChannel\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setServiceProperty(String name, String value, ServicePropertyChannel channel)"
desc: "Sets a property value that will be passed to service using the specified channel."
type: "class"
desc: "Class that defines base configurations for dialog service connector. Note: close() must be called in order to release underlying resources held by the object."
implements:
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.cognitiveservices.speech.dialog"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0