Endpoints - List Base Model Logs
Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/{locale}/files/logs
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/{locale}/files/logs?sasValidityInSeconds={sasValidityInSeconds}&skipToken={skipToken}&top={top}
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). |
locale
|
path | True |
string |
The language used to select the default base model. |
sas
|
query |
integer (int32) |
The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated. |
|
skip
|
query |
string |
Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined. |
|
top
|
query |
integer (int32) |
Number of datasets that will be included after skipping. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
An error occurred. |
Security
Ocp-Apim-Subscription-Key
Provide your cognitive services account key here.
Type:
apiKey
In:
header
Authorization
Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement
Type:
apiKey
In:
header
Examples
Get all base model logs
Sample request
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/Acoustic/files/logs?sasValidityInSeconds=120&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&top=2
Sample response
{
"values": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
"name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
"kind": "Audio",
"properties": {
"size": 12345
},
"createdDateTime": "2020-01-13T08:00:00Z",
"links": {
"contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
}
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
"name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
"kind": "Transcription",
"properties": {
"size": 12345
},
"createdDateTime": "2020-01-13T08:00:00Z",
"links": {
"contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
}
}
],
"@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/base/en-us/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--"
}
Definitions
Name | Description |
---|---|
Detailed |
DetailedErrorCode |
Error |
Error |
Error |
ErrorCode |
File |
File |
File |
FileKind |
File |
FileLinks |
File |
FileProperties |
Inner |
InnerError |
Paginated |
PaginatedFiles |
DetailedErrorCode
DetailedErrorCode
Value | Description |
---|---|
InvalidParameterValue |
Invalid parameter value. |
InvalidRequestBodyFormat |
Invalid request body format. |
EmptyRequest |
Empty Request. |
MissingInputRecords |
Missing Input Records. |
InvalidDocument |
Invalid Document. |
ModelVersionIncorrect |
Model Version Incorrect. |
InvalidDocumentBatch |
Invalid Document Batch. |
UnsupportedLanguageCode |
Unsupported language code. |
DataImportFailed |
Data import failed. |
InUseViolation |
In use violation. |
InvalidLocale |
Invalid locale. |
InvalidBaseModel |
Invalid base model. |
InvalidAdaptationMapping |
Invalid adaptation mapping. |
InvalidDataset |
Invalid dataset. |
InvalidTest |
Invalid test. |
FailedDataset |
Failed dataset. |
InvalidModel |
Invalid model. |
InvalidTranscription |
Invalid transcription. |
InvalidPayload |
Invalid payload. |
InvalidParameter |
Invalid parameter. |
EndpointWithoutLogging |
Endpoint without logging. |
InvalidPermissions |
Invalid permissions. |
InvalidPrerequisite |
Invalid prerequisite. |
InvalidProductId |
Invalid product id. |
InvalidSubscription |
Invalid subscription. |
InvalidProject |
Invalid project. |
InvalidProjectKind |
Invalid project kind. |
InvalidRecordingsUri |
Invalid recordings uri. |
OnlyOneOfUrlsOrContainerOrDataset |
Only one of urls or container or dataset. |
ExceededNumberOfRecordingsUris |
Exceeded number of recordings uris. |
ModelMismatch |
Model mismatch. |
ProjectGenderMismatch |
Project gender mismatch. |
ModelDeprecated |
Model deprecated. |
ModelExists |
Model exists. |
ModelNotDeployable |
Model not deployable. |
EndpointNotUpdatable |
Endpoint not updatable. |
SingleDefaultEndpoint |
Single default endpoint. |
EndpointCannotBeDefault |
Endpoint cannot be default. |
InvalidModelUri |
Invalid model uri. |
SubscriptionNotFound |
Subscription not found. |
QuotaViolation |
Quota violation. |
UnsupportedDelta |
Unsupported delta. |
UnsupportedFilter |
Unsupported filter. |
UnsupportedPagination |
Unsupported pagination. |
UnsupportedDynamicConfiguration |
Unsupported dynamic configuration. |
UnsupportedOrderBy |
Unsupported order by. |
NoUtf8WithBom |
No utf8 with bom. |
ModelDeploymentNotCompleteState |
Model deployment not complete state. |
SkuLimitsExist |
Sku limits exist. |
DeployingFailedModel |
Deploying failed model. |
UnsupportedTimeRange |
Unsupported time range. |
InvalidLogDate |
Invalid log date. |
InvalidLogId |
Invalid log id. |
InvalidLogStartTime |
Invalid log start time. |
InvalidLogEndTime |
Invalid log end time. |
InvalidTopForLogs |
Invalid top for logs. |
InvalidSkipTokenForLogs |
Invalid skip token for logs. |
DeleteNotAllowed |
Delete not allowed. |
Forbidden |
Forbidden. |
DeployNotAllowed |
Deploy not allowed. |
UnexpectedError |
Unexpected error. |
InvalidCollection |
Invalid collection. |
InvalidCallbackUri |
Invalid callback uri. |
InvalidSasValidityDuration |
Invalid sas validity duration. |
InaccessibleCustomerStorage |
Inaccessible customer storage. |
UnsupportedClassBasedAdaptation |
Unsupported class based adaptation. |
InvalidWebHookEventKind |
Invalid web hook event kind. |
InvalidTimeToLive |
Invalid time to live. |
InvalidSourceAzureResourceId |
Invalid source Azure resource ID. |
ModelCopyOperationExists |
Model copy operation exists. |
Error
Error
Name | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Additional supportive details regarding the error and/or expected policies. |
innerError |
InnerError |
|
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
ErrorCode
Value | Description |
---|---|
InvalidRequest |
Representing the invalid request error code. |
InvalidArgument |
Representing the invalid argument error code. |
InternalServerError |
Representing the internal server error error code. |
ServiceUnavailable |
Representing the service unavailable error code. |
NotFound |
Representing the not found error code. |
PipelineError |
Representing the pipeline error error code. |
Conflict |
Representing the conflict error code. |
InternalCommunicationFailed |
Representing the internal communication failed error code. |
Forbidden |
Representing the forbidden error code. |
NotAllowed |
Representing the not allowed error code. |
Unauthorized |
Representing the unauthorized error code. |
UnsupportedMediaType |
Representing the unsupported media type error code. |
TooManyRequests |
Representing the too many requests error code. |
UnprocessableEntity |
Representing the unprocessable entity error code. |
File
File
Name | Type | Description |
---|---|---|
createdDateTime |
string (date-time) |
The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
kind |
FileKind |
|
links |
FileLinks |
|
name |
string |
The name of this file. |
properties |
FileProperties |
|
self |
string (uri) |
The location of this entity. |
FileKind
FileKind
Value | Description |
---|---|
DatasetReport |
Type of data is dataset report. |
Audio |
Type of data is audio. |
LanguageData |
Type of data is language data. |
PronunciationData |
Type of data is pronunciation data. |
AcousticDataArchive |
Type of data is acoustic data archive. |
AcousticDataTranscriptionV2 |
Type of data is acoustic data transcription v2. |
Transcription |
Type of data is transcription. |
TranscriptionReport |
Type of data is transcription report. |
EvaluationDetails |
Type of data is evaluation details. |
ModelReport |
Type of data is model report. |
OutputFormattingData |
Type of data is output formatting input file. |
FileLinks
FileLinks
Name | Type | Description |
---|---|---|
contentUrl |
string (uri) |
The url to retrieve the content of this file. |
FileProperties
FileProperties
Name | Type | Description |
---|---|---|
duration |
string |
The duration in case this file is an audio file. The duration is encoded as ISO 8601 duration ("PnYnMnDTnHnMnS", see https://en.wikipedia.org/wiki/ISO_8601#Durations). |
size |
integer (int64) |
The size of the data in bytes. |
InnerError
InnerError
Name | Type | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Additional supportive details regarding the error and/or expected policies. |
innerError |
InnerError |
|
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. |
PaginatedFiles
PaginatedFiles
Name | Type | Description |
---|---|---|
@nextLink |
string (uri) |
A link to the next set of paginated results if there are more entities available; otherwise null. |
values |
File[] |
A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. |