azure.cognitiveservices.speech.PronunciationAssessmentConfig.yml

### YamlMime:PythonClass
uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig
name: PronunciationAssessmentConfig
fullName: azure.cognitiveservices.speech.PronunciationAssessmentConfig
module: azure.cognitiveservices.speech
inheritances:
- builtins.object
summary: "Represents pronunciation assessment configuration\n\n> [!NOTE]\n> Added\
  \ in version 1.14.0.\n>\n\nThe configuration can be initialized in two ways:\n\n\
  * from parameters: pass reference text, grading system, granularity, enable miscue\
  \ and scenario id. \n\n* from json: pass a json string \n\nFor the parameters details,\
  \ see\n[https://docs.microsoft.com/azure/cognitive-services/speech-service/rest-speech-to-text#pronunciation-assessment-parameters](https://docs.microsoft.com/azure/cognitive-services/speech-service/rest-speech-to-text#pronunciation-assessment-parameters)"
constructor:
  syntax: 'PronunciationAssessmentConfig(reference_text: str | None = None, grading_system:
    PronunciationAssessmentGradingSystem = PronunciationAssessmentGradingSystem.FivePoint,
    granularity: PronunciationAssessmentGranularity = PronunciationAssessmentGranularity.Phoneme,
    enable_miscue: bool = False, json_string: str | None = None)'
  parameters:
  - name: reference_text
    description: The reference text for pronunciation assessment
    defaultValue: None
  - name: grading_system
    description: The point system for score calibration
    defaultValue: PronunciationAssessmentGradingSystem.FivePoint
  - name: granularity
    description: The evaluation granularity
    defaultValue: PronunciationAssessmentGranularity.Phoneme
  - name: enable_miscue
    description: If enables miscue calculation
    defaultValue: 'False'
  - name: json_string
    description: A json string representing pronunciation assessment parameters
    defaultValue: None
methods:
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.apply_to
  name: apply_to
  summary: Apply the settings in this config to a recognizer.
  signature: 'apply_to(recognizer: Recognizer) -> None'
  parameters:
  - name: recognizer
    description: the target recognizer.
    isRequired: true
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.enable_content_assessment_with_topic
  name: enable_content_assessment_with_topic
  summary: Enable content assessment with topic.
  signature: 'enable_content_assessment_with_topic(topic: str) -> None'
  parameters:
  - name: topic
    description: the topic.
    isRequired: true
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.enable_prosody_assessment
  name: enable_prosody_assessment
  summary: Enable prosody assessment.
  signature: enable_prosody_assessment() -> None
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.to_json
  name: to_json
  summary: Gets to json string of pronunciation assessment parameters.
  signature: to_json() -> str
  return:
    description: the json string.
attributes:
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.nbest_phoneme_count
  name: nbest_phoneme_count
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.phoneme_alphabet
  name: phoneme_alphabet
- uid: azure.cognitiveservices.speech.PronunciationAssessmentConfig.reference_text
  name: reference_text
  summary: The reference text.