Call Media - Recognize

Referentie

Service:: Communication

API-versie:: 2024-09-15

Media herkennen uit gesprek.

POST {endpoint}/calling/callConnections/{callConnectionId}:recognize?api-version=2024-09-15

URI-parameters

Name	In	Vereist	Type	Description
callConnectionId	path	True	string	De oproepverbindings-id
endpoint	path	True	string url	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een Azure Communication Services-toegangstoken voor gebruikers.

Aanvraagbody

Name	Vereist	Type	Description
recognizeInputType	True	RecognizeInputType	Bepaalt het type herkenning.
recognizeOptions	True	RecognizeOptions	Hiermee definieert u opties voor herkenning.
interruptCallMediaOperation		boolean	Als herkennen is ingesteld, kunnen er andere bestaande aanvragen in de wachtrij worden geplaatst/momenteel worden verwerkt.
operationCallbackUri		string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext		string	De waarde om de context van de bewerking te identificeren.
playPrompt		PlaySource	De bron van de audio die moet worden afgespeeld voor herkenning.
playPrompts		PlaySource[]	De bron van de audio die moet worden afgespeeld voor herkenning.

Antwoorden

Name	Type	Description
202 Accepted		De service heeft de recognize-aanvraag geaccepteerd en begint met het verwerken ervan. U ontvangt de gebeurtenis RecognizeCompleted of RecognizeFailed op uw opgegeven callback-URI om u bij te werken over de status van de aanvraag.
Other Status Codes	CommunicationErrorResponse	Fout

Beveiliging

Authorization

Een Azure Communication Services-toegangstoken voor gebruikers.

Type: apiKey
In: header

Voorbeelden

CallMedia_Recognize

Voorbeeldaanvraag

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:recognize?api-version=2024-09-15

{
  "recognizeInputType": "dtmf",
  "playPrompt": {
    "kind": "file",
    "file": {
      "uri": "https://some.file.azure.com/sample.wav"
    }
  },
  "recognizeOptions": {
    "interruptPrompt": true,
    "initialSilenceTimeoutInSeconds": 5,
    "targetParticipant": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    },
    "dtmfOptions": {
      "interToneTimeoutInSeconds": 3,
      "maxTonesToCollect": 5,
      "stopTones": [
        "pound"
      ]
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Voorbeeldrespons

Statuscode:: 202

Definities

Name	Description
Choice
DtmfOptions	Opties voor DTMF-herkenning
FileSource
PlaySource
PlaySourceType	Definieert het type play-bron
RecognizeInputType	Bepaalt het type herkenning.
RecognizeOptions
RecognizeRequest
SpeechOptions	Opties voor continue spraakherkenning
SsmlSource
TextSource
Tone
VoiceKind	Type stemtype

Choice

Name	Type	Description
label	string	Id voor een bepaalde keuze
phrases	string[]	Lijst met te herkennen woordgroepen
tone	Tone

DtmfOptions

Opties voor DTMF-herkenning

Name	Type	Description
interToneTimeoutInSeconds	integer	Tijd om te wachten tussen DTMF-invoer om te stoppen met herkennen.
maxTonesToCollect	integer	Maximum aantal DTMF-tonen dat moet worden verzameld.
stopTones	Tone[]	Lijst met tonen die stoppen met herkennen.

FileSource

Name	Type	Description
uri	string	URI voor het afspelen van het audiobestand

PlaySource

Name	Type	Description
file	FileSource	Hiermee definieert u de brongegevens van het bestand die moeten worden gebruikt voor afspelen
kind	PlaySourceType	Definieert het type play-bron
playSourceCacheId	string	Definieert de id die moet worden gebruikt voor het opslaan van gerelateerde media in de cache
ssml	SsmlSource	Definieert de brongegevens van ssml (Speech Synthesis Markup Language) die moeten worden gebruikt voor afspelen
text	TextSource	Definieert de tekstbrongegevens die moeten worden gebruikt voor afspelen

PlaySourceType

Definieert het type play-bron

Name	Type	Description
file	string
ssml	string
text	string

RecognizeInputType

Bepaalt het type herkenning.

Name	Type	Description
choices	string
dtmf	string
speech	string
speechOrDtmf	string

RecognizeOptions

Name	Type	Description
choices	Choice[]	Definieert Ivr-keuzes voor herkennen.
dtmfOptions	DtmfOptions	Hiermee definieert u configuraties voor DTMF.
initialSilenceTimeoutInSeconds	integer	Tijd om te wachten op eerste invoer na prompt (indien van toepassing).
interruptPrompt	boolean	Bepaalt of we de prompt onderbreken en beginnen met herkennen.
speechLanguage	string	Spraaktaal die moet worden herkend, is en-US
speechOptions	SpeechOptions	Hiermee definieert u de optie voor continue spraakherkenning.
speechRecognitionModelEndpointId	string	Eindpunt waar het aangepaste model is geïmplementeerd.
targetParticipant	CommunicationIdentifierModel

RecognizeRequest

Name	Type	Description
interruptCallMediaOperation	boolean	Als herkennen is ingesteld, kunnen er andere bestaande aanvragen in de wachtrij worden geplaatst/momenteel worden verwerkt.
operationCallbackUri	string	Stel een callback-URI in waarmee de standaard callback-URI wordt overschreven die is ingesteld door CreateCall/AnswerCall voor deze bewerking. Deze instelling is per actie. Als dit niet is ingesteld, wordt de standaard callback-URI die is ingesteld door CreateCall/AnswerCall gebruikt.
operationContext	string	De waarde om de context van de bewerking te identificeren.
playPrompt	PlaySource	De bron van de audio die moet worden afgespeeld voor herkenning.
playPrompts	PlaySource[]	De bron van de audio die moet worden afgespeeld voor herkenning.
recognizeInputType	RecognizeInputType	Bepaalt het type herkenning.
recognizeOptions	RecognizeOptions	Hiermee definieert u opties voor herkenning.

SpeechOptions

Opties voor continue spraakherkenning

Name	Type	Description
endSilenceTimeoutInMs	integer	De lengte van de stilte van de eindgebruiker wanneer de gebruiker stopt met spreken en cogservice antwoord verzendt.

SsmlSource

Name	Type	Description
customVoiceEndpointId	string	Eindpunt waar de aangepaste stem is geïmplementeerd.
ssmlText	string	Ssml-tekenreeks voor de cognitieve service die moet worden afgespeeld

TextSource

Name	Type	Description
customVoiceEndpointId	string	Eindpunt waar de aangepaste stem is geïmplementeerd.
sourceLocale	string	De landinstellingen van de brontaal die u wilt afspelen, verwijzen hier naar beschikbare landinstellingen:
text	string	Tekst voor de cognitieve service die moet worden afgespeeld
voiceKind	VoiceKind	Type stemtype
voiceName	string	Stemnaam die moet worden afgespeeld Raadpleeg hier beschikbare stemmen voor tekst-naar-spraak:

Tone

Name	Type	Description
a	string
asterisk	string
b	string
c	string
d	string
eight	string
five	string
four	string
nine	string
one	string
pound	string
seven	string
six	string
three	string
two	string
zero	string

VoiceKind

Type stemtype

Name	Type	Description
female	string
male	string

Delen via