Endpoints - Delete Base Model Logs

Service:

Azure AI Services

API Version:

v3.2-preview.2

Deletes the specified audio and transcription logs that have been stored when using the default base model of a given language. It deletes all logs before (and including) a specific day.
Deletion process is done asynchronously and can take up to one day depending on the amount of log files.

DELETE {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/{locale}/files/logs

With optional parameters:

DELETE {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/{locale}/files/logs?endDate={endDate}

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.
endDate	query		string	The end date of the audio logs deletion (specific day, UTC). Expected format: "yyyy-mm-dd". For instance, "2023-03-15" results in deleting all logs on March 15th, 2023 and before. Deletes all existing logs when date is not specified.

Responses

Name	Type	Description
202 Accepted		The logs will be deleted.
Other Status Codes	Error	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

Delete all base model logs

Sample request

HTTP

DELETE {endpoint}/speechtotext/v3.2-preview.2/endpoints/base/Acoustic/files/logs?endDate=2019-01-01

Sample response

Status code:

202

Definitions

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError

DetailedErrorCode

Enumeration

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

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
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.

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.