Connection class

Pakiet:

microsoft-cognitiveservices-speech-sdk

Połączenie to klasa serwera proxy do zarządzania połączeniem z usługą rozpoznawania mowy określonego rozpoznawania. Domyślnie rozpoznawanie autonomiczne zarządza połączeniem z usługą w razie potrzeby. Klasa Connection udostępnia dodatkowe metody jawnego otwierania lub zamykania połączenia oraz subskrybowania zmian stanu połączenia. Użycie połączenia jest opcjonalne i dotyczy głównie scenariuszy, w których wymagane jest precyzyjne dostrajanie zachowania aplikacji na podstawie stanu połączenia. Użytkownicy mogą opcjonalnie wywołać metodę Open(), aby ręcznie skonfigurować połączenie z wyprzedzeniem przed rozpoczęciem rozpoznawania w rozpoznawaniu skojarzonym z tym połączeniem. Jeśli narzędzie rozpoznawania musi nawiązać połączenie lub rozłączyć się z usługą, skonfiguruje lub wyłączy połączenie niezależnie. W takim przypadku połączenie zostanie powiadomione o zmianie stanu połączenia za pośrednictwem zdarzeń Połączony/Rozłączony. Dodano w wersji 1.2.1.

Właściwości

connected	Zdarzenie Połączone wskazujące, że rozpoznawanie jest połączone z usługą.
disconnected	Zdarzenie Rozłączone, aby wskazać, że rozpoznawanie jest odłączone od usługi.
messageReceived	Wszelkie komunikaty odebrane z usługi Mowa.
messageSent	Każda wiadomość wysłana do usługi mowa.
receivedServiceMessage	Każdy komunikat z usługi, który nie jest przetwarzany przez inne narzędzia rozpoznawania najwyższego poziomu. Zostanie usunięty w wersji 2.0.

Metody

close()	Usuwanie skojarzonych zasobów.
closeConnection(() => void, (error: string) => void)	Zamyka połączenie z usługą. Użytkownicy mogą opcjonalnie wywołać metodę closeConnection(), aby ręcznie zamknąć połączenie skojarzonego programu Recognizer. Jeśli funkcja closeConnection() jest wywoływana podczas rozpoznawania, rozpoznawanie zakończy się niepowodzeniem i anuluje z powodu błędu.
fromRecognizer(Recognizer | ConversationTranscriber)	Pobiera wystąpienie połączenia z określonego rozpoznawania.
fromSynthesizer(SpeechSynthesizer)	Pobiera wystąpienie połączenia z określonego syntetyzatora.
openConnection(() => void, (error: string) => void)	Rozpoczyna konfigurowanie połączenia z usługą. Użytkownicy mogą opcjonalnie wywołać metodę openConnection(), aby ręcznie skonfigurować połączenie z wyprzedzeniem przed rozpoczęciem rozpoznawania w rozpoznawaniu skojarzonym z tym połączeniem. Po rozpoczęciu rozpoznawania wywołanie metody Open() nie będzie miało wpływu Uwaga: Po powrocie połączenie może nie być jeszcze gotowe. Zasubskrybuj zdarzenie Połączone, aby otrzymywać powiadomienia po nawiązaniu połączenia.
sendMessageAsync(string, string | ArrayBuffer, () => void, (error: string) => void)	Wysyła komunikat do usługi mowy. Dodano w wersji 1.13.0.
setMessageProperty(string, string, string | object)	Dołącza parametr w komunikacie do usługi. Dodano w wersji 1.12.1.

Szczegóły właściwości

connected

Zdarzenie Połączone wskazujące, że rozpoznawanie jest połączone z usługą.

connected: (args: ConnectionEventArgs) => void

Wartość właściwości

(args: ConnectionEventArgs) => void

disconnected

Zdarzenie Rozłączone, aby wskazać, że rozpoznawanie jest odłączone od usługi.

disconnected: (args: ConnectionEventArgs) => void

Wartość właściwości

(args: ConnectionEventArgs) => void

messageReceived

Wszelkie komunikaty odebrane z usługi Mowa.

messageReceived: (args: ConnectionMessageEventArgs) => void

Wartość właściwości

(args: ConnectionMessageEventArgs) => void

messageSent

Każda wiadomość wysłana do usługi mowa.

messageSent: (args: ConnectionMessageEventArgs) => void

Wartość właściwości

(args: ConnectionMessageEventArgs) => void

receivedServiceMessage

Każdy komunikat z usługi, który nie jest przetwarzany przez inne narzędzia rozpoznawania najwyższego poziomu.

Zostanie usunięty w wersji 2.0.

receivedServiceMessage: (args: ServiceEventArgs) => void

Wartość właściwości

(args: ServiceEventArgs) => void

Szczegóły metody

close()

Usuwanie skojarzonych zasobów.

function close()

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

Zamyka połączenie z usługą. Użytkownicy mogą opcjonalnie wywołać metodę closeConnection(), aby ręcznie zamknąć połączenie skojarzonego programu Recognizer.

Jeśli funkcja closeConnection() jest wywoływana podczas rozpoznawania, rozpoznawanie zakończy się niepowodzeniem i anuluje z powodu błędu.

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

Parametry

cb

() => void

err

(error: string) => void

fromRecognizer(Recognizer | ConversationTranscriber)

Pobiera wystąpienie połączenia z określonego rozpoznawania.

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

Parametry

recognizer

Recognizer | ConversationTranscriber

Rozpoznawanie skojarzone z połączeniem.

Zwraca

Connection

Wystąpienie połączenia rozpoznawania.

fromSynthesizer(SpeechSynthesizer)

Pobiera wystąpienie połączenia z określonego syntetyzatora.

static function fromSynthesizer(synthesizer: SpeechSynthesizer): Connection

Parametry

synthesizer

SpeechSynthesizer

Syntetyzator skojarzony z połączeniem.

Zwraca

Connection

Wystąpienie połączenia syntetyzatora.

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

Rozpoczyna konfigurowanie połączenia z usługą. Użytkownicy mogą opcjonalnie wywołać metodę openConnection(), aby ręcznie skonfigurować połączenie z wyprzedzeniem przed rozpoczęciem rozpoznawania w rozpoznawaniu skojarzonym z tym połączeniem. Po rozpoczęciu rozpoznawania wywołanie metody Open() nie będzie miało wpływu

Uwaga: Po powrocie połączenie może nie być jeszcze gotowe. Zasubskrybuj zdarzenie Połączone, aby otrzymywać powiadomienia po nawiązaniu połączenia.

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

Parametry

cb

() => void

err

(error: string) => void

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

Wysyła komunikat do usługi mowy. Dodano w wersji 1.13.0.

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

Parametry

path

string

Ścieżka protokołu WebSocket komunikatu

payload

string | ArrayBuffer

Ładunek komunikatu. Jest to ciąg json lub arrayBuffer.

success

() => void

Wywołanie zwrotne wskazujące powodzenie.

error

(error: string) => void

Wywołanie zwrotne wskazujące błąd.

setMessageProperty(string, string, string | object)

Dołącza parametr w komunikacie do usługi. Dodano w wersji 1.12.1.

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

Parametry

path

string

Ścieżka komunikatu sieciowego.

propertyName

string

Nazwa właściwości

propertyValue

string | object

Wartość właściwości. Jest to ciąg json.