Connection class

  • Riferimento
Pacchetto:
microsoft-cognitiveservices-speech-sdk

La connessione è una classe proxy per la gestione della connessione al servizio voce del sistema di riconoscimento specificato. Per impostazione predefinita, un recognizer gestisce in modo autonomo la connessione al servizio quando necessario. La classe Connection fornisce metodi aggiuntivi per consentire agli utenti di aprire o chiudere in modo esplicito una connessione e di sottoscrivere le modifiche dello stato della connessione. L'uso di Connection è facoltativo e principalmente per gli scenari in cui è necessaria l'ottimizzazione del comportamento dell'applicazione in base allo stato della connessione. Gli utenti possono facoltativamente chiamare Open() per configurare manualmente una connessione in anticipo prima di avviare il riconoscimento nel sistema di riconoscimento associato a questa connessione. Se recognizer deve connettersi o disconnettersi al servizio, verrà configurata o arrestata la connessione in modo indipendente. In questo caso, la connessione riceverà una notifica modificando lo stato della connessione tramite eventi Connessi/Disconnessi. Aggiunta nella versione 1.2.1.

Proprietà

connected

Evento Connected per indicare che il riconoscitore è connesso al servizio.
disconnected

Evento Disconnected per indicare che il riconoscitore è disconnesso dal servizio.
messageReceived

Qualsiasi messaggio ricevuto dal servizio Voce.
messageSent

Qualsiasi messaggio inviato al servizio Voce.
receivedServiceMessage

Qualsiasi messaggio del servizio che non viene elaborato da altri riconoscitori di livello superiore.

Verrà rimosso nella versione 2.0.

Metodi

close()

Eliminare le risorse associate.
closeConnection(() => void, (error: string) => void)

Chiude la connessione al servizio. Gli utenti possono facoltativamente chiamare closeConnection() per arrestare manualmente la connessione del sistema di riconoscimento associato.

Se closeConnection() viene chiamato durante il riconoscimento, il riconoscimento avrà esito negativo e verrà annullato con un errore.
fromRecognizer(Recognizer | ConversationTranscriber)

Ottiene l'istanza di Connection dal riconoscitore specificato.
fromSynthesizer(SpeechSynthesizer)

Ottiene l'istanza connection dal sintetizzatore specificato.
openConnection(() => void, (error: string) => void)

Avvia la configurazione della connessione al servizio. Gli utenti possono facoltativamente chiamare openConnection() per configurare manualmente una connessione in anticipo prima di avviare il riconoscimento nel sistema di riconoscimento associato a questa connessione. Dopo l'avvio del riconoscimento, la chiamata a Open() non avrà alcun effetto

Nota: al momento della restituzione, la connessione potrebbe non essere ancora pronta. Sottoscrivere l'evento Connected per ricevere una notifica quando viene stabilita la connessione.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)

Invia un messaggio al servizio di riconoscimento vocale. Aggiunta nella versione 1.13.0.
setMessageProperty(string, string, string | object)

Aggiunge un parametro in un messaggio al servizio. Aggiunta nella versione 1.12.1.

Dettagli proprietà

connected

Evento Connected per indicare che il riconoscitore è connesso al servizio.

connected: (args: ConnectionEventArgs) => void

Valore della proprietà

(args: ConnectionEventArgs) => void

disconnected

Evento Disconnected per indicare che il riconoscitore è disconnesso dal servizio.

disconnected: (args: ConnectionEventArgs) => void

Valore della proprietà

(args: ConnectionEventArgs) => void

messageReceived

Qualsiasi messaggio ricevuto dal servizio Voce.

messageReceived: (args: ConnectionMessageEventArgs) => void

Valore della proprietà

(args: ConnectionMessageEventArgs) => void

messageSent

Qualsiasi messaggio inviato al servizio Voce.

messageSent: (args: ConnectionMessageEventArgs) => void

Valore della proprietà

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Qualsiasi messaggio del servizio che non viene elaborato da altri riconoscitori di livello superiore.

Verrà rimosso nella versione 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Valore della proprietà

(args: ServiceEventArgs) => void

Dettagli metodo

close()

Eliminare le risorse associate.

function close()

closeConnection(() => void, (error: string) => void)

Chiude la connessione al servizio. Gli utenti possono facoltativamente chiamare closeConnection() per arrestare manualmente la connessione del sistema di riconoscimento associato.

Se closeConnection() viene chiamato durante il riconoscimento, il riconoscimento avrà esito negativo e verrà annullato con un errore.

function closeConnection(cb?: () => void, err?: (error: string) => void)

Parametri

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Ottiene l'istanza di Connection dal riconoscitore specificato.

static function fromRecognizer(recognizer: Recognizer | ConversationTranscriber): Connection

Parametri

recognizer

Recognizer | ConversationTranscriber

Riconoscitore associato alla connessione.

Restituisce

Connection

Istanza connection del riconoscitore.

fromSynthesizer(SpeechSynthesizer)

Ottiene l'istanza connection dal sintetizzatore specificato.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parametri

synthesizer
SpeechSynthesizer

Sintetizzatore associato alla connessione.

Restituisce

Connection

Istanza connection del sintetizzatore.

openConnection(() => void, (error: string) => void)

Avvia la configurazione della connessione al servizio. Gli utenti possono facoltativamente chiamare openConnection() per configurare manualmente una connessione in anticipo prima di avviare il riconoscimento nel sistema di riconoscimento associato a questa connessione. Dopo l'avvio del riconoscimento, la chiamata a Open() non avrà alcun effetto

Nota: al momento della restituzione, la connessione potrebbe non essere ancora pronta. Sottoscrivere l'evento Connected per ricevere una notifica quando viene stabilita la connessione.

function openConnection(cb?: () => void, err?: (error: string) => void)

Parametri

cb

() => void

err

(error: string) => void

sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)

Invia un messaggio al servizio di riconoscimento vocale. Aggiunta nella versione 1.13.0.

function sendMessageAsync(path: string, payload: string | ArrayBuffer, success?: () => void, error?: (error: string) => void)

Parametri

path

string

Percorso WebSocket del messaggio

payload

string | ArrayBuffer

Payload del messaggio. Si tratta di una stringa JSON o di un arrayBuffer.

success

() => void

Callback per indicare l'esito positivo.

error

(error: string) => void

Callback per indicare un errore.

setMessageProperty(string, string, string | object)

Aggiunge un parametro in un messaggio al servizio. Aggiunta nella versione 1.12.1.

function setMessageProperty(path: string, propertyName: string, propertyValue: string | object)

Parametri

path

string

Percorso del messaggio di rete.

propertyName

string

Nome della proprietà

propertyValue

string | object

Valore della proprietà. Si tratta di una stringa json.