Evaluations - Get

Reference

Service:: Azure AI Services

API Version:: 2024-11-15

Gets the evaluation identified by the given ID.

GET {endpoint}/speechtotext/evaluations/{id}?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	The identifier of the evaluation.
api-version	query	True	string	The requested api version.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your cognitive services account key here.

Responses

Name	Type	Description
200 OK	Evaluation	OK Headers Retry-After: integer
Other Status Codes	Error	An error occurred.

Name

Type

Description

200 OK

Evaluation

Headers

Retry-After: integer

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Examples

Get a evaluation

Sample request

HTTP

GET {endpoint}/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-11-15

Sample response

Status code:: 200

{
  "displayName": "Evalution of one model against another model",
  "description": "The description of the evaluation",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-11-15",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-11-15"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-11-15"
  },
  "locale": "en-US",
  "properties": {
    "wordErrorRate1": 0.065,
    "sentenceErrorRate1": 0.375,
    "tokenErrorRate1": 0.125,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0,
    "tokenErrors1": {
      "punctuation": {
        "numberOfEdits": 2,
        "percentageOfAllEdits": 0.66
      },
      "capitalization": {
        "numberOfEdits": 1,
        "percentageOfAllEdits": 0.33
      }
    },
    "wordErrorRate2": 0.065,
    "sentenceErrorRate2": 0.375,
    "tokenErrorRate2": 0.125,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenErrors2": {
      "punctuation": {
        "numberOfEdits": 208,
        "percentageOfAllEdits": 1.22
      },
      "capitalization": {
        "numberOfEdits": 126,
        "percentageOfAllEdits": 0.74
      },
      "inverseTextNormalization": {
        "numberOfEdits": 409,
        "percentageOfAllEdits": 2.4
      },
      "lexical": {
        "numberOfEdits": 16284,
        "percentageOfAllEdits": 95.41
      },
      "others": {
        "numberOfEdits": 41,
        "percentageOfAllEdits": 0.24
      }
    }
  },
  "status": "Succeeded"
}

Definitions

Name	Description
DetailedErrorCode	DetailedErrorCode
EditsSummary	EditsSummary
EntityError	EntityError
EntityReference	EntityReference
Error	Error
ErrorCode	ErrorCode
Evaluation	Evaluation
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
InnerError	InnerError
Status	Status
TokenErrorDetails	TokenErrorDetails

DetailedErrorCode

Enumeration

DetailedErrorCode

Value	Description
AudioLengthLimitExceeded	The audio file is longer than the maximum allowed duration.
BadChannelConfiguration	There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
DataImportFailed	Data import failed.
DeleteNotAllowed	Delete not allowed.
DeployNotAllowed	Deploy not allowed.
DeployingFailedModel	Deploying failed model.
EmptyAudioFile	The audio file is empty.
EmptyRequest	Empty Request.
EndpointCannotBeDefault	Endpoint cannot be default.
EndpointLoggingNotSupported	Endpoint logging not supported.
EndpointNotUpdatable	Endpoint not updatable.
EndpointWithoutLogging	Endpoint without logging.
ExceededNumberOfRecordingsUris	Exceeded number of recordings uris.
FailedDataset	Failed dataset.
Forbidden	Forbidden.
InUseViolation	In use violation.
InaccessibleCustomerStorage	Inaccessible customer storage.
InvalidAdaptationMapping	Invalid adaptation mapping.
InvalidAudioFormat	The format of input audio is not supported.
InvalidBaseModel	Invalid base model.
InvalidCallbackUri	Invalid callback uri.
InvalidChannelSpecification	The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
InvalidChannels	Invalid channels.
InvalidCollection	Invalid collection.
InvalidDataset	Invalid dataset.
InvalidDocument	Invalid Document.
InvalidDocumentBatch	Invalid Document Batch.
InvalidLocale	Invalid locale.
InvalidLogDate	Invalid log date.
InvalidLogEndTime	Invalid log end time.
InvalidLogId	Invalid log id.
InvalidLogStartTime	Invalid log start time.
InvalidModel	Invalid model.
InvalidModelUri	Invalid model uri.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
InvalidPayload	Invalid payload.
InvalidPermissions	Invalid permissions.
InvalidPrerequisite	Invalid prerequisite.
InvalidProductId	Invalid product id.
InvalidProject	Invalid project.
InvalidProjectKind	Invalid project kind.
InvalidRecordingsUri	Invalid recordings uri.
InvalidRequestBodyFormat	Invalid request body format.
InvalidSasValidityDuration	Invalid sas validity duration.
InvalidSkipTokenForLogs	Invalid skip token for logs.
InvalidSourceAzureResourceId	Invalid source Azure resource ID.
InvalidSubscription	Invalid subscription.
InvalidTest	Invalid test.
InvalidTimeToLive	Invalid time to live.
InvalidTopForLogs	Invalid top for logs.
InvalidTranscription	Invalid transcription.
InvalidWebHookEventKind	Invalid web hook event kind.
MissingInputRecords	Missing Input Records.
ModelCopyAuthorizationExpired	Expired ModelCopyAuthorization.
ModelDeploymentNotCompleteState	Model deployment not complete state.
ModelDeprecated	Model deprecated.
ModelExists	Model exists.
ModelMismatch	Model mismatch.
ModelNotDeployable	Model not deployable.
ModelVersionIncorrect	Model Version Incorrect.
MultipleLanguagesIdentified	Language Identification recognized multiple languages. No dominant language could be determined.
NoLanguageIdentified	Language Identification did not recognize any language.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Only one of urls or container or dataset.
ProjectGenderMismatch	Project gender mismatch.
QuotaViolation	Quota violation.
SingleDefaultEndpoint	Single default endpoint.
SkuLimitsExist	Sku limits exist.
SubscriptionNotFound	Subscription not found.
UnexpectedError	Unexpected error.
UnsupportedClassBasedAdaptation	Unsupported class based adaptation.
UnsupportedDelta	Unsupported delta.
UnsupportedDynamicConfiguration	Unsupported dynamic configuration.
UnsupportedFilter	Unsupported filter.
UnsupportedLanguageCode	Unsupported language code.
UnsupportedOrderBy	Unsupported order by.
UnsupportedPagination	Unsupported pagination.
UnsupportedTimeRange	Unsupported time range.

EditsSummary

Object

EditsSummary

Name	Type	Description
numberOfEdits	integer (int32)	The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription.
percentageOfAllEdits	number (double)	The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription.

EntityError

Object

EntityError

Name	Type	Description
code	string	The code of this error.
message	string	The message for this error.

EntityReference

Object

EntityReference

Name	Type	Description
self	string (uri)	The location of the referenced entity.

Error

Object

Error

Name	Type	Description
code	ErrorCode	ErrorCode High level error codes.
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Enumeration

ErrorCode

Value	Description
Conflict	Representing the conflict error code.
Forbidden	Representing the forbidden error code.
InternalCommunicationFailed	Representing the internal communication failed error code.
InternalServerError	Representing the internal server error error code.
InvalidArgument	Representing the invalid argument error code.
InvalidRequest	Representing the invalid request error code.
NotAllowed	Representing the not allowed error code.
NotFound	Representing the not found error code.
PipelineError	Representing the pipeline error error code.
ServiceUnavailable	Representing the service unavailable error code.
TooManyRequests	Representing the too many requests error code.
Unauthorized	Representing the unauthorized error code.
UnprocessableEntity	Representing the unprocessable entity error code.
UnsupportedMediaType	Representing the unsupported media type error code.

Evaluation

Object

Evaluation

Name	Type	Description
createdDateTime	string (date-time)	The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.
dataset	EntityReference	EntityReference
description	string	The description of the object.
displayName	string minLength: 1	The display name of the object.
lastActionDateTime	string (date-time)	The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EvaluationLinks	EvaluationLinks
locale	string minLength: 1	The locale of the contained data.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string (uri)	The location of this entity.
status	Status	Status Describe the current state of the API.
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Object

EvaluationLinks

Name	Type	Description
files	string (uri)	The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details.

EvaluationProperties

Object

EvaluationProperties

Name	Type	Description
correctTokenCount1	integer (int32)	The optional number of correctly recognized tokens by model1.
correctTokenCount2	integer (int32)	The optional number of correctly recognized tokens by model2.
correctWordCount1	integer (int32)	The number of correctly recognized words by model1.
correctWordCount2	integer (int32)	The number of correctly recognized words by model2.
error	EntityError	EntityError
sentenceCount1	integer (int32)	The number of processed sentences by model1.
sentenceCount2	integer (int32)	The number of processed sentences by model2.
sentenceErrorRate1	number (double)	The sentence error rate of recognition with model1.
sentenceErrorRate2	number (double)	The sentence error rate of recognition with model2.
tokenCount1	integer (int32)	The optional number of processed tokens by model1.
tokenCount2	integer (int32)	The optional number of processed tokens by model2.
tokenDeletionCount1	integer (int32)	The optional number of recognized tokens by model1, that are deletions.
tokenDeletionCount2	integer (int32)	The optional number of recognized tokens by model2, that are deletions.
tokenErrorRate1	number (double)	The optional token error rate of recognition with model1.
tokenErrorRate2	number (double)	The optional token error rate of recognition with model2.
tokenErrors1	TokenErrorDetails	TokenErrorDetails
tokenErrors2	TokenErrorDetails	TokenErrorDetails
tokenInsertionCount1	integer (int32)	The optional number of recognized tokens by model1, that are insertions.
tokenInsertionCount2	integer (int32)	The optional number of recognized tokens by model2, that are insertions.
tokenSubstitutionCount1	integer (int32)	The optional number of recognized tokens by model1, that are substitutions.
tokenSubstitutionCount2	integer (int32)	The optional number of recognized tokens by model2, that are substitutions.
wordCount1	integer (int32)	The number of processed words by model1.
wordCount2	integer (int32)	The number of processed words by model2.
wordDeletionCount1	integer (int32)	The number of recognized words by model1, that are deletions.
wordDeletionCount2	integer (int32)	The number of recognized words by model2, that are deletions.
wordErrorRate1	number (double)	The word error rate of recognition with model1.
wordErrorRate2	number (double)	The word error rate of recognition with model2.
wordInsertionCount1	integer (int32)	The number of recognized words by model1, that are insertions.
wordInsertionCount2	integer (int32)	The number of recognized words by model2, that are insertions.
wordSubstitutionCount1	integer (int32)	The number of recognized words by model1, that are substitutions.
wordSubstitutionCount2	integer (int32)	The number of recognized words by model2, that are substitutions.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Detailed error code enum.
details	object	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

Status

Enumeration

Status

Value	Description
Failed	The long running operation has failed.
NotStarted	The long running operation has not yet started.
Running	The long running operation is currently processing.
Succeeded	The long running operation has successfully completed.

TokenErrorDetails

Object

TokenErrorDetails

Name	Type	Description
capitalization	EditsSummary	EditsSummary
inverseTextNormalization	EditsSummary	EditsSummary
lexical	EditsSummary	EditsSummary
others	EditsSummary	EditsSummary
punctuation	EditsSummary	EditsSummary

Share via

Evaluations - Get

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Get a evaluation

Sample request

Sample response

Definitions

DetailedErrorCode

EditsSummary

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

Status

TokenErrorDetails

Additional resources