PromptMetadata

public struct PromptMetadata : Codable, Equatable

Information about the prompt that is to be added to a custom model. The following example of a PromptMetadata object includes both the required prompt text and an optional speaker model ID: { "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }.

  • The required written text of the spoken prompt. The length of a prompt’s text is limited to a few sentences. Speaking one or two sentences of text is the recommended limit. A prompt cannot contain more than 1000 characters of text. Escape any XML control characters (double quotes, single quotes, ampersands, angle brackets, and slashes) that appear in the text of the prompt.

    Declaration

    Swift

    public var promptText: String

  • The optional speaker ID (GUID) of a previously defined speaker model that is to be associated with the prompt.

    Declaration

    Swift

    public var speakerID: String?

  • Initialize a PromptMetadata with member variables.

    Declaration

    Swift

    public init(
    promptText: String,
    speakerID: String? = nil
)

    Parameters

    promptText

    The required written text of the spoken prompt. The length of a prompt’s text is limited to a few sentences. Speaking one or two sentences of text is the recommended limit. A prompt cannot contain more than 1000 characters of text. Escape any XML control characters (double quotes, single quotes, ampersands, angle brackets, and slashes) that appear in the text of the prompt.
    speakerID

    The optional speaker ID (GUID) of a previously defined speaker model that is to be associated with the prompt.

    Return Value

    An initialized PromptMetadata.