SpeechKit Audit Trails Events: RecognizeSpeechAsync
- Event JSON schema
- Field description
- IamAuthentication
- IamTokenInfo
- Authorization
- ResourceMetadata
- Resource
- RequestMetadata
- Status
- EventDetails
- RecognitionModelOptions
- AudioFormatOptions
- RawAudio
- ContainerAudio
- TextNormalizationOptions
- LanguageRestrictionOptions
- RecognitionClassifierOptions
- RecognitionClassifier
- SpeechAnalysisOptions
- SpeakerAnalysisOptions
- ConversationAnalysisOptions
- SpeakerLabelingOptions
Event JSON schema
{
"eventId": "string",
"eventSource": "string",
"eventType": "string",
"eventTime": "string",
"authentication": {
"authenticated": "boolean",
// Includes only one of the fields `subjectType`
"subjectType": "string",
// end of the list of possible fields
// Includes only one of the fields `subjectId`
"subjectId": "string",
// end of the list of possible fields
// Includes only one of the fields `subjectName`
"subjectName": "string",
// end of the list of possible fields
// Includes only one of the fields `federationId`
"federationId": "string",
// end of the list of possible fields
// Includes only one of the fields `federationName`
"federationName": "string",
// end of the list of possible fields
// Includes only one of the fields `federationType`
"federationType": "string",
// end of the list of possible fields
"tokenInfo": {
"maskedIamToken": "string",
// Includes only one of the fields `iamTokenId`
"iamTokenId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorId`
"impersonatorId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorType`
"impersonatorType": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorName`
"impersonatorName": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationId`
"impersonatorFederationId": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationName`
"impersonatorFederationName": "string",
// end of the list of possible fields
// Includes only one of the fields `impersonatorFederationType`
"impersonatorFederationType": "string"
// end of the list of possible fields
}
},
"authorization": {
"authorized": "boolean"
},
"resourceMetadata": {
"path": [
{
"resourceType": "string",
"resourceId": "string",
// Includes only one of the fields `resourceName`
"resourceName": "string"
// end of the list of possible fields
}
]
},
"requestMetadata": {
"remoteAddress": "string",
"userAgent": "string",
"requestId": "string",
// Includes only one of the fields `remotePort`
"remotePort": "string"
// end of the list of possible fields
},
"eventStatus": "string",
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"details": {
"modelId": "string",
"sourceType": "string",
"recognitionModel": {
"model": "string",
"audioFormat": {
// Includes only one of the fields `rawAudio`, `containerAudio`
"rawAudio": {
"audioEncoding": "string",
"sampleRateHertz": "string",
"audioChannelCount": "string"
},
"containerAudio": {
"containerAudioType": "string"
}
// end of the list of possible fields
},
"textNormalization": {
"textNormalization": "string",
"profanityFilter": "boolean",
"literatureText": "boolean",
"phoneFormattingMode": "string"
},
"languageRestriction": {
"restrictionType": "string",
"languageCode": [
"string"
]
},
"audioProcessingType": "string"
},
"recognitionClassifier": {
"classifiers": [
{
"classifier": "string",
"triggers": [
"string"
]
}
]
},
"speechAnalysis": {
"enableSpeakerAnalysis": "boolean",
"enableConversationAnalysis": "boolean",
"descriptiveStatisticsQuantiles": [
"string"
],
"speakerOptions": {
"silenceThresholdMs": "string"
},
"converstationOptions": {
"simultaneousSilenceThresholdMs": "string",
"simultaneousSpeechThresholdMs": "string"
}
},
"speakerLabeling": {
"speakerLabeling": "string"
},
"version": "string"
}
}
Field description
|
Field |
Description |
|
eventId |
string |
|
eventSource |
string |
|
eventType |
string |
|
eventTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
|
authentication |
|
|
authorization |
|
|
resourceMetadata |
|
|
requestMetadata |
|
|
eventStatus |
enum (EventStatus)
|
|
error |
The error result of the operation in case of failure or cancellation. |
|
details |
IamAuthentication
|
Field |
Description |
|
authenticated |
boolean |
|
subjectType |
enum (IamSubjectType) Includes only one of the fields
|
|
subjectId |
string Includes only one of the fields |
|
subjectName |
string Includes only one of the fields |
|
federationId |
string Includes only one of the fields |
|
federationName |
string Includes only one of the fields |
|
federationType |
enum (FederationType) Includes only one of the fields
|
|
tokenInfo |
IamTokenInfo
|
Field |
Description |
|
maskedIamToken |
string |
|
iamTokenId |
string Includes only one of the fields |
|
impersonatorId |
string Includes only one of the fields |
|
impersonatorType |
enum (IamSubjectType) Includes only one of the fields
|
|
impersonatorName |
string Includes only one of the fields |
|
impersonatorFederationId |
string Includes only one of the fields |
|
impersonatorFederationName |
string Includes only one of the fields |
|
impersonatorFederationType |
enum (FederationType) Includes only one of the fields
|
Authorization
|
Field |
Description |
|
authorized |
boolean |
ResourceMetadata
|
Field |
Description |
|
path[] |
Resource
|
Field |
Description |
|
resourceType |
string |
|
resourceId |
string |
|
resourceName |
string Includes only one of the fields |
RequestMetadata
|
Field |
Description |
|
remoteAddress |
string |
|
userAgent |
string |
|
requestId |
string |
|
remotePort |
string (int64) Includes only one of the fields |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
EventDetails
|
Field |
Description |
|
modelId |
string |
|
sourceType |
enum (SourceType)
|
|
recognitionModel |
|
|
recognitionClassifier |
|
|
speechAnalysis |
|
|
speakerLabeling |
|
|
version |
enum (ApiVersion)
|
RecognitionModelOptions
|
Field |
Description |
|
model |
string |
|
audioFormat |
|
|
textNormalization |
|
|
languageRestriction |
|
|
audioProcessingType |
enum (AudioProcessingType)
|
AudioFormatOptions
|
Field |
Description |
|
rawAudio |
Includes only one of the fields |
|
containerAudio |
Includes only one of the fields |
RawAudio
|
Field |
Description |
|
audioEncoding |
enum (AudioEncoding)
|
|
sampleRateHertz |
string (int64) |
|
audioChannelCount |
string (int64) |
ContainerAudio
|
Field |
Description |
|
containerAudioType |
enum (ContainerAudioType)
|
TextNormalizationOptions
|
Field |
Description |
|
textNormalization |
enum (TextNormalization)
|
|
profanityFilter |
boolean |
|
literatureText |
boolean |
|
phoneFormattingMode |
enum (PhoneFormattingMode)
|
LanguageRestrictionOptions
|
Field |
Description |
|
restrictionType |
enum (LanguageRestrictionType)
|
|
languageCode[] |
string |
RecognitionClassifierOptions
|
Field |
Description |
|
classifiers[] |
RecognitionClassifier
|
Field |
Description |
|
classifier |
string |
|
triggers[] |
enum (TriggerType)
|
SpeechAnalysisOptions
|
Field |
Description |
|
enableSpeakerAnalysis |
boolean |
|
enableConversationAnalysis |
boolean |
|
descriptiveStatisticsQuantiles[] |
string |
|
speakerOptions |
|
|
converstationOptions |
SpeakerAnalysisOptions
|
Field |
Description |
|
silenceThresholdMs |
string (int64) |
ConversationAnalysisOptions
|
Field |
Description |
|
simultaneousSilenceThresholdMs |
string (int64) |
|
simultaneousSpeechThresholdMs |
string (int64) |
SpeakerLabelingOptions
|
Field |
Description |
|
speakerLabeling |
enum (SpeakerLabeling)
|