### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel"
fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel"
name: "KeywordRecognitionModel"
nameWithType: "KeywordRecognitionModel"
summary: "Represents a keyword recognition model for recognizing when the user says a keyword to initiate further speech recognition."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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 **KeywordRecognitionModel**</br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.close()"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.close()"
  name: "close()"
  nameWithType: "KeywordRecognitionModel.close()"
  summary: "Dispose of associated resources."
  syntax: "public void close()"
  desc: "Dispose of associated resources."
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromConfig(com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig)"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig)"
  name: "fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig)"
  nameWithType: "KeywordRecognitionModel.fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig)"
  summary: "Creates a keyword recognition model using the specified embedded speech config."
  modifiers:
  - "static"
  parameters:
  - description: "Embedded speech config."
    name: "embeddedSpeechConfig"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig?alt=com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig&text=EmbeddedSpeechConfig\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static KeywordRecognitionModel fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig)"
  desc: "Creates a keyword recognition model using the specified embedded speech config."
  returns:
    description: "The keyword recognition model."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.KeywordRecognitionModel?alt=com.microsoft.cognitiveservices.speech.KeywordRecognitionModel&text=KeywordRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromConfig(com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig,java.util.List<java.lang.String>)"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig, List<String> userDefinedWakeWords)"
  name: "fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig, List<String> userDefinedWakeWords)"
  nameWithType: "KeywordRecognitionModel.fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig, List<String> userDefinedWakeWords)"
  summary: "Creates a keyword recognition model using the specified embedded speech config and user-defined wake words."
  modifiers:
  - "static"
  parameters:
  - description: "Embedded speech config."
    name: "embeddedSpeechConfig"
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig?alt=com.microsoft.cognitiveservices.speech.EmbeddedSpeechConfig&text=EmbeddedSpeechConfig\" data-throw-if-not-resolved=\"False\" />"
  - description: "User-defined wake words."
    name: "userDefinedWakeWords"
    type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public static KeywordRecognitionModel fromConfig(EmbeddedSpeechConfig embeddedSpeechConfig, List<String> userDefinedWakeWords)"
  desc: "Creates a keyword recognition model using the specified embedded speech config and user-defined wake words."
  returns:
    description: "The keyword recognition model."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.KeywordRecognitionModel?alt=com.microsoft.cognitiveservices.speech.KeywordRecognitionModel&text=KeywordRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromFile(java.lang.String)"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromFile(String fileName)"
  name: "fromFile(String fileName)"
  nameWithType: "KeywordRecognitionModel.fromFile(String fileName)"
  summary: "Creates a keyword recognition model using the specified filename."
  modifiers:
  - "static"
  parameters:
  - description: "A string that represents file name for the keyword recognition model.\n                 Note, the file can point to a zip file in which case the model will be extracted from the zip."
    name: "fileName"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static KeywordRecognitionModel fromFile(String fileName)"
  desc: "Creates a keyword recognition model using the specified filename."
  returns:
    description: "The keyword recognition model being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.KeywordRecognitionModel?alt=com.microsoft.cognitiveservices.speech.KeywordRecognitionModel&text=KeywordRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromStream(java.io.InputStream,java.lang.String,boolean)"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.fromStream(InputStream inputStream, String name, boolean isZipped)"
  name: "fromStream(InputStream inputStream, String name, boolean isZipped)"
  nameWithType: "KeywordRecognitionModel.fromStream(InputStream inputStream, String name, boolean isZipped)"
  summary: "Creates a keyword recognition model using the specified input stream."
  modifiers:
  - "static"
  parameters:
  - description: "A stream that represents data for the keyword recognition model.\n                 Note, the file can be a zip file in which case the model will be extracted from the zip."
    name: "inputStream"
    type: "<xref href=\"java.io.InputStream?alt=java.io.InputStream&text=InputStream\" data-throw-if-not-resolved=\"False\" />"
  - description: "The name of the keyword. Note: The name needs to be unique for different keywords as it will be\n             used internally to match a particular keyword spotter model. In case you are updating the keyword\n             with a new version, add a version tag to the name or otherwise the previous version will be\n             overwritten on disk."
    name: "name"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "If true, the input stream is treated as a zip. false, if the input is just the kws table file."
    name: "isZipped"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static KeywordRecognitionModel fromStream(InputStream inputStream, String name, boolean isZipped)"
  exceptions:
  - description: "In case the kws.table file was not found or the temp directory could not be created."
    type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
  desc: "Creates a keyword recognition model using the specified input stream."
  returns:
    description: "The keyword recognition model being created."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.KeywordRecognitionModel?alt=com.microsoft.cognitiveservices.speech.KeywordRecognitionModel&text=KeywordRecognitionModel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.getImpl()"
  fullName: "com.microsoft.cognitiveservices.speech.KeywordRecognitionModel.getImpl()"
  name: "getImpl()"
  nameWithType: "KeywordRecognitionModel.getImpl()"
  summary: "Returns the keyword recognition model."
  syntax: "public SafeHandle getImpl()"
  desc: "Returns the keyword recognition model."
  returns:
    description: "The implementation of the model."
    type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a keyword recognition model for recognizing when the user says a keyword to initiate further speech recognition. 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"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0