swagger: '2.0' info: version: 2020-08-01-preview title: 'Microsoft Azure AccessControlClient AccessConnector Custom Speech Projects: API' schemes: - https tags: - name: 'Custom Speech Projects:' paths: /projects/locales: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Supported Locales operationId: microsoftAzureGetsupportedprojectlocales produces: - application/json responses: '200': description: OK schema: type: array items: type: string default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get the supported locales: $ref: ./examples/get_supported_project_locales.json description: Needs a more full description created. /projects: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Projects For The Authenticated Subscription operationId: microsoftAzureGetprojects produces: - application/json parameters: - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedProjects' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all projects: $ref: ./examples/get_projects.json description: Needs a more full description created. post: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Creates A New Project operationId: microsoftAzureCreateproject consumes: - application/json produces: - application/json parameters: - in: body name: project description: The details of the project. required: true schema: $ref: '#/definitions/Project' responses: '201': description: The response contains information about the entity as payload and its location as header. schema: $ref: '#/definitions/Project' headers: Location: description: The location of the created resource. type: string format: uri default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Create a project: $ref: ./examples/create_project.json description: Needs a more full description created. /projects/{id}: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The Project Identified By The Given Id operationId: microsoftAzureGetproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid responses: '200': description: OK schema: $ref: '#/definitions/Project' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Get a project: $ref: ./examples/get_project.json description: Needs a more full description created. patch: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Updates The Project Identified By The Given Id operationId: microsoftAzureUpdateproject consumes: - application/json - application/merge-patch+json produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - in: body name: projectUpdate description: The updated values for the project. required: true schema: $ref: '#/definitions/ProjectUpdate' responses: '200': description: OK schema: $ref: '#/definitions/Project' default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Update a project: $ref: ./examples/update_project.json description: Needs a more full description created. delete: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Deletes The Project Identified By The Given Id operationId: microsoftAzureDeleteproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid responses: '204': description: The project was successfully deleted or did not exist. default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-examples: Delete a project: $ref: ./examples/delete_project.json description: Needs a more full description created. /projects/{id}/evaluations: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Evaluations For Specified Project operationId: microsoftAzureGetevaluationsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedEvaluations' headers: Retry-After: description: The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all evaluations: $ref: ./examples/get_project_evaluations.json description: Needs a more full description created. /projects/{id}/datasets: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Datasets For Specified Project operationId: microsoftAzureGetdatasetsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedDatasets' headers: Retry-After: description: The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all datasets: $ref: ./examples/get_project_datasets.json description: Needs a more full description created. /projects/{id}/endpoints: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Endpoints For Specified Project operationId: microsoftAzureGetendpointsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedEndpoints' headers: Retry-After: description: The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all endpoints: $ref: ./examples/get_project_endpoints.json description: Needs a more full description created. /projects/{id}/models: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Models For Specified Project operationId: microsoftAzureGetmodelsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedModels' headers: Retry-After: description: The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all models: $ref: ./examples/get_project_models.json description: Needs a more full description created. /projects/{id}/transcriptions: get: tags: - 'Custom Speech Projects:' summary: Microsoft Azure Gets The List Of Transcriptions For Specified Project operationId: microsoftAzureGettranscriptionsforproject produces: - application/json parameters: - in: path name: id description: The identifier of the project. required: true type: string format: uuid - $ref: '#/parameters/skipQueryParameter' - $ref: '#/parameters/topQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/PaginatedTranscriptions' headers: Retry-After: description: The minimum number of seconds to wait for a non terminal operation to complete. type: integer default: description: An error occurred. schema: $ref: '#/definitions/Error' x-ms-pageable: itemName: values nextLinkName: '@nextLink' x-ms-examples: Get all transcriptions: $ref: ./examples/get_project_transcriptions.json description: Needs a more full description created. definitions: ProjectProperties: title: ProjectProperties type: object properties: datasetCount: format: int32 description: The number of datasets associated to this project. type: integer readOnly: true evaluationCount: format: int32 description: The number of evaluations associated to this project. type: integer readOnly: true modelCount: format: int32 description: The number of models associated to this project. type: integer readOnly: true transcriptionCount: format: int32 description: The number of transcriptions associated to this project. type: integer readOnly: true endpointCount: format: int32 description: The number of endpoints associated to this project. type: integer readOnly: true PaginatedEndpoints: title: PaginatedEndpoints type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Endpoint' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedTranscriptions: title: PaginatedTranscriptions type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Transcription' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true EntityError: title: EntityError type: object properties: code: description: The code of this error. type: string readOnly: true message: description: The message for this error. type: string readOnly: true EvaluationProperties: title: EvaluationProperties type: object properties: wordErrorRate2: format: double description: The word error rate of recognition with model2. type: number readOnly: true wordErrorRate1: format: double description: The word error rate of recognition with model1. type: number readOnly: true sentenceErrorRate2: format: double description: The sentence error rate of recognition with model2. type: number readOnly: true sentenceCount2: format: int32 description: The number of processed sentences by model2. type: integer readOnly: true wordCount2: format: int32 description: The number of processed words by model2. type: integer readOnly: true correctWordCount2: format: int32 description: The number of correctly recognized words by model2. type: integer readOnly: true wordSubstitutionCount2: format: int32 description: The number of recognized words by model2, that are substitutions. type: integer readOnly: true wordDeletionCount2: format: int32 description: The number of recognized words by model2, that are deletions. type: integer readOnly: true wordInsertionCount2: format: int32 description: The number of recognized words by model2, that are insertions. type: integer readOnly: true sentenceErrorRate1: format: double description: The sentence error rate of recognition with model1. type: number readOnly: true sentenceCount1: format: int32 description: The number of processed sentences by model1. type: integer readOnly: true wordCount1: format: int32 description: The number of processed words by model1. type: integer readOnly: true correctWordCount1: format: int32 description: The number of correctly recognized words by model1. type: integer readOnly: true wordSubstitutionCount1: format: int32 description: The number of recognized words by model1, that are substitutions. type: integer readOnly: true wordDeletionCount1: format: int32 description: The number of recognized words by model1, that are deletions. type: integer readOnly: true wordInsertionCount1: format: int32 description: The number of recognized words by model1, that are insertions. type: integer readOnly: true email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' PaginatedProjects: title: PaginatedProjects type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Project' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true Evaluation: title: Evaluation required: - dataset - displayName - locale - model1 - model2 type: object properties: model1: $ref: '#/definitions/EntityReference' model2: $ref: '#/definitions/EntityReference' transcription1: $ref: '#/definitions/EntityReference' transcription2: $ref: '#/definitions/EntityReference' dataset: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/EvaluationProperties' project: $ref: '#/definitions/EntityReference' self: format: uri description: The location of this entity. type: string readOnly: true lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string locale: description: The locale of the contained data. type: string InnerError: title: InnerError description: "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.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested)." type: object properties: code: $ref: '#/definitions/DetailedErrorCode' details: description: Additional supportive details regarding the error and/or expected policies. type: object additionalProperties: type: string message: description: High level error message. type: string target: description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document." type: string innerError: $ref: '#/definitions/InnerError' DatasetProperties: title: DatasetProperties type: object properties: acceptedLineCount: format: int32 description: The number of lines accepted for this data set. type: integer readOnly: true rejectedLineCount: format: int32 description: The number of lines rejected for this data set. type: integer readOnly: true duration: description: "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string readOnly: true email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' Links: title: Links type: object properties: files: format: uri description: The location to get all files of this entity. type: string readOnly: true Project: title: Project required: - displayName - locale type: object properties: links: $ref: '#/definitions/ProjectLinks' properties: $ref: '#/definitions/ProjectProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string locale: description: The locale of the contained data. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true EndpointProperties: title: EndpointProperties type: object properties: loggingEnabled: description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. type: boolean timeToLive: description: "How long the endpoint will be kept in the system. Once the endpoint reaches the time to live\r\nafter completion (successful or failed) it will be automatically deleted. Not setting this value or setting\r\nto 0 will disable automatic deletion. The longest supported duration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' Model: title: Model required: - displayName - locale type: object properties: project: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/ModelLinks' properties: $ref: '#/definitions/ModelProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string text: description: The text used to adapt this language model. type: string baseModel: $ref: '#/definitions/EntityReference' datasets: description: Datasets used for adaptation. type: array items: $ref: '#/definitions/EntityReference' locale: description: The locale of the contained data. type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string EntityReference: title: EntityReference required: - self type: object properties: self: format: uri description: The location of the referenced entity. type: string TranscriptionProperties: title: TranscriptionProperties type: object properties: diarizationEnabled: description: "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`." type: boolean wordLevelTimestampsEnabled: description: "A value indicating whether word level timestamps are requested. The default value is\r\n`false`." type: boolean duration: description: "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string readOnly: true channels: description: "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered." type: array items: format: int32 type: integer destinationContainerUrl: format: uri description: "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.
\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up." type: string punctuationMode: $ref: '#/definitions/PunctuationMode' profanityFilterMode: $ref: '#/definitions/ProfanityFilterMode' timeToLive: description: "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted. Not setting this value or setting it to 0 will disable automatic deletion. The longest supported\r\nduration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations)." type: string email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' PunctuationMode: title: PunctuationMode description: The mode used for punctuation. enum: - None - Dictated - Automatic - DictatedAndAutomatic type: string x-ms-enum: name: PunctuationMode modelAsString: false values: - value: None description: No punctuation. - value: Dictated description: Dictated punctuation marks only, i.e., explicit punctuation. - value: Automatic description: Automatic punctuation. - value: DictatedAndAutomatic description: Dictated punctuation marks or automatic punctuation. ModelProperties: title: ModelProperties type: object properties: deprecationDates: $ref: '#/definitions/ModelDeprecationDates' email: description: "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email." type: string error: $ref: '#/definitions/EntityError' PaginatedEvaluations: title: PaginatedEvaluations type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Evaluation' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true PaginatedDatasets: title: PaginatedDatasets type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Dataset' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true ProfanityFilterMode: title: ProfanityFilterMode description: Mode of profanity filtering. enum: - None - Removed - Tags - Masked type: string x-ms-enum: name: ProfanityFilterMode modelAsString: false values: - value: None description: Disable profanity filtering. - value: Removed description: Remove profanity. - value: Tags description: Add "profanity" XML tags</Profanity> - value: Masked description: Mask the profanity with * except of the first letter, e.g., f*** EndpointLinks: title: EndpointLinks type: object properties: restInteractive: format: uri description: The REST endpoint for short requests up to 15 seconds. type: string readOnly: true restConversation: format: uri description: The REST endpoint for requests up to 60 seconds. type: string readOnly: true restDictation: format: uri description: The REST endpoint for requests up to 60 seconds, supporting dictation of punctuation marks. type: string readOnly: true webSocketInteractive: format: uri description: The Speech SDK endpoint for short requests up to 15 seconds with a single final result. type: string readOnly: true webSocketConversation: format: uri description: The Speech SDK endpoint for long requests with multiple final results. type: string readOnly: true webSocketDictation: format: uri description: "The Speech SDK endpoint for long requests with multiple final results, supporting dictation of\r\npunctuation marks." type: string readOnly: true logs: format: uri description: The audio and transcription logs for this endpoint. type: string readOnly: true Status: title: Status description: Describe the current state of the API enum: - NotStarted - Running - Succeeded - Failed type: string readOnly: true x-ms-enum: name: Status modelAsString: false values: - value: NotStarted description: The long running operation has not yet started. - value: Running description: The long running operation is currently processing. - value: Succeeded description: The long running operation has successfully completed. - value: Failed description: The long running operation has failed. Transcription: title: Transcription required: - displayName - locale type: object properties: links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/TranscriptionProperties' self: format: uri description: The location of this entity. type: string readOnly: true model: $ref: '#/definitions/EntityReference' project: $ref: '#/definitions/EntityReference' dataset: $ref: '#/definitions/EntityReference' contentUrls: description: "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response." type: array items: format: uri type: string contentContainerUrl: format: uri description: "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response." type: string displayName: description: The display name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string locale: description: The locale of the contained data. type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true DatasetKind: title: DatasetKind description: Type of data import. enum: - Language - Acoustic - Pronunciation - AudioFiles type: string x-ms-enum: name: DatasetKind modelAsString: false values: - value: Language description: A language data import. - value: Acoustic description: An acoustic data import. - value: Pronunciation description: A pronunciation data import. - value: AudioFiles description: An audio files data import. Error: title: Error description: "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details." type: object properties: code: $ref: '#/definitions/ErrorCode' details: description: Additional supportive details regarding the error and/or expected policies. type: array items: $ref: '#/definitions/Error' message: description: High level error message. type: string target: description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document." type: string innerError: $ref: '#/definitions/InnerError' ModelLinks: title: ModelLinks type: object properties: manifest: format: uri description: The location to get a manifest for this model to be used in the on-prem container. type: string readOnly: true copyTo: format: uri description: The location to the model copy action. type: string readOnly: true ErrorCode: title: ErrorCode description: High level error codes. enum: - InvalidRequest - InvalidArgument - InternalServerError - ServiceUnavailable - NotFound - PipelineError - Conflict - InternalCommunicationFailed - Forbidden - NotAllowed - Unauthorized - UnsupportedMediaType - TooManyRequests - UnprocessableEntity type: string x-ms-enum: name: ErrorCode modelAsString: true values: - value: InvalidRequest description: Representing the invalid request error code. - value: InvalidArgument description: Representing the invalid argument error code. - value: InternalServerError description: Representing the internal server error error code. - value: ServiceUnavailable description: Representing the service unavailable error code. - value: NotFound description: Representing the not found error code. - value: PipelineError description: Representing the pipeline error error code. - value: Conflict description: Representing the conflict error code. - value: InternalCommunicationFailed description: Representing the internal communication failed error code. - value: Forbidden description: Representing the forbidden error code. - value: NotAllowed description: Representing the not allowed error code. - value: Unauthorized description: Representing the unauthorized error code. - value: UnsupportedMediaType description: Representing the unsupported media type error code. - value: TooManyRequests description: Representing the too many requests error code. - value: UnprocessableEntity description: Representing the unprocessable entity error code. PaginatedModels: title: PaginatedModels type: object properties: values: description: "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list." type: array items: $ref: '#/definitions/Model' readOnly: true '@nextLink': format: uri description: A link to the next set of paginated results if there are more entities available; otherwise null. type: string readOnly: true ModelDeprecationDates: title: ModelDeprecationDates type: object properties: adaptationDateTime: format: date-time type: string readOnly: true transcriptionDateTime: format: date-time type: string readOnly: true DetailedErrorCode: title: DetailedErrorCode description: Detailed error code enum. enum: - InvalidParameterValue - InvalidRequestBodyFormat - EmptyRequest - MissingInputRecords - InvalidDocument - ModelVersionIncorrect - InvalidDocumentBatch - UnsupportedLanguageCode - DataImportFailed - InUseViolation - InvalidLocale - InvalidBaseModel - InvalidAdaptationMapping - InvalidDataset - InvalidTest - FailedDataset - InvalidModel - InvalidTranscription - InvalidPayload - InvalidParameter - EndpointWithoutLogging - InvalidPermissions - InvalidPrerequisite - InvalidProductId - InvalidSubscription - InvalidProject - InvalidProjectKind - InvalidRecordingsUri - OnlyOneOfUrlsOrContainerOrDataset - ExceededNumberOfRecordingsUris - ModelMismatch - ProjectGenderMismatch - ModelDeprecated - ModelExists - ModelNotDeployable - EndpointNotUpdatable - SingleDefaultEndpoint - EndpointCannotBeDefault - InvalidModelUri - SubscriptionNotFound - QuotaViolation - UnsupportedDelta - UnsupportedFilter - UnsupportedPagination - UnsupportedDynamicConfiguration - UnsupportedOrderBy - NoUtf8WithBom - ModelDeploymentNotCompleteState - SkuLimitsExist - DeployingFailedModel - UnsupportedTimeRange - InvalidLogDate - InvalidLogId - InvalidLogStartTime - InvalidLogEndTime - InvalidTopForLogs - InvalidSkipTokenForLogs - DeleteNotAllowed - Forbidden - DeployNotAllowed - UnexpectedError - InvalidCollection - InvalidCallbackUri - InvalidSasValidityDuration - InaccessibleCustomerStorage - UnsupportedClassBasedAdaptation - InvalidWebHookEventKind - InvalidTimeToLive type: string x-ms-enum: name: DetailedErrorCode modelAsString: true values: - value: InvalidParameterValue description: Invalid parameter value. - value: InvalidRequestBodyFormat description: Invalid request body format. - value: EmptyRequest description: Empty Request. - value: MissingInputRecords description: Missing Input Records. - value: InvalidDocument description: Invalid Document. - value: ModelVersionIncorrect description: Model Version Incorrect. - value: InvalidDocumentBatch description: Invalid Document Batch. - value: UnsupportedLanguageCode description: Unsupported language code. - value: DataImportFailed description: Data import failed. - value: InUseViolation description: In use violation. - value: InvalidLocale description: Invalid locale. - value: InvalidBaseModel description: Invalid base model. - value: InvalidAdaptationMapping description: Invalid adaptation mapping. - value: InvalidDataset description: Invalid dataset. - value: InvalidTest description: Invalid test. - value: FailedDataset description: Failed dataset. - value: InvalidModel description: Invalid model. - value: InvalidTranscription description: Invalid transcription. - value: InvalidPayload description: Invalid payload. - value: InvalidParameter description: Invalid parameter. - value: EndpointWithoutLogging description: Endpoint without logging. - value: InvalidPermissions description: Invalid permissions. - value: InvalidPrerequisite description: Invalid prerequisite. - value: InvalidProductId description: Invalid product id. - value: InvalidSubscription description: Invalid subscription. - value: InvalidProject description: Invalid project. - value: InvalidProjectKind description: Invalid project kind. - value: InvalidRecordingsUri description: Invalid recordings uri. - value: OnlyOneOfUrlsOrContainerOrDataset description: Only one of urls or container or dataset. - value: ExceededNumberOfRecordingsUris description: Exceeded number of recordings uris. - value: ModelMismatch description: Model mismatch. - value: ProjectGenderMismatch description: Project gender mismatch. - value: ModelDeprecated description: Model deprecated. - value: ModelExists description: Model exists. - value: ModelNotDeployable description: Model not deployable. - value: EndpointNotUpdatable description: Endpoint not updatable. - value: SingleDefaultEndpoint description: Single default endpoint. - value: EndpointCannotBeDefault description: Endpoint cannot be default. - value: InvalidModelUri description: Invalid model uri. - value: SubscriptionNotFound description: Subscription not found. - value: QuotaViolation description: Quota violation. - value: UnsupportedDelta description: Unsupported delta. - value: UnsupportedFilter description: Unsupported filter. - value: UnsupportedPagination description: Unsupported pagination. - value: UnsupportedDynamicConfiguration description: Unsupported dynamic configuration. - value: UnsupportedOrderBy description: Unsupported order by. - value: NoUtf8WithBom description: No utf8 with bom. - value: ModelDeploymentNotCompleteState description: Model deployment not complete state. - value: SkuLimitsExist description: Sku limits exist. - value: DeployingFailedModel description: Deploying failed model. - value: UnsupportedTimeRange description: Unsupported time range. - value: InvalidLogDate description: Invalid log date. - value: InvalidLogId description: Invalid log id. - value: InvalidLogStartTime description: Invalid log start time. - value: InvalidLogEndTime description: Invalid log end time. - value: InvalidTopForLogs description: Invalid top for logs. - value: InvalidSkipTokenForLogs description: Invalid skip token for logs. - value: DeleteNotAllowed description: Delete not allowed. - value: Forbidden description: Forbidden. - value: DeployNotAllowed description: Deploy not allowed. - value: UnexpectedError description: Unexpected error. - value: InvalidCollection description: Invalid collection. - value: InvalidCallbackUri description: Invalid callback uri. - value: InvalidSasValidityDuration description: Invalid sas validity duration. - value: InaccessibleCustomerStorage description: Inaccessible customer storage. - value: UnsupportedClassBasedAdaptation description: Unsupported class based adaptation. - value: InvalidWebHookEventKind description: Invalid web hook event kind. - value: InvalidTimeToLive description: Invalid time to live. Dataset: title: Dataset required: - displayName - kind - locale type: object properties: links: $ref: '#/definitions/Links' properties: $ref: '#/definitions/DatasetProperties' kind: $ref: '#/definitions/DatasetKind' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string project: $ref: '#/definitions/EntityReference' contentUrl: format: uri description: The URL of the data for the dataset. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string locale: description: The locale of the contained data. type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true Endpoint: title: Endpoint required: - displayName - locale type: object properties: project: $ref: '#/definitions/EntityReference' links: $ref: '#/definitions/EndpointLinks' properties: $ref: '#/definitions/EndpointProperties' self: format: uri description: The location of this entity. type: string readOnly: true displayName: description: The display name of the object. type: string description: description: The description of the object. type: string text: description: The text used to adapt a language model for this endpoint. type: string model: $ref: '#/definitions/EntityReference' locale: description: The locale of the contained data. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string lastActionDateTime: format: date-time description: "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true status: $ref: '#/definitions/Status' createdDateTime: format: date-time description: "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)." type: string readOnly: true ProjectUpdate: title: ProjectUpdate type: object properties: displayName: description: The name of the object. type: string description: description: The description of the object. type: string customProperties: description: "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10." type: object additionalProperties: type: string ProjectLinks: title: ProjectLinks type: object properties: evaluations: format: uri description: The location to get a list of all evaluations of this project. type: string readOnly: true datasets: format: uri description: The location to get a list of all datasets of this project. type: string readOnly: true models: format: uri description: The location to get a list of all models of this project. type: string readOnly: true endpoints: format: uri description: The location to get a list of all endpoints of this project. type: string readOnly: true transcriptions: format: uri description: The location to get a list of all transcriptions of this project. type: string readOnly: true parameters: topQueryParameter: in: query name: top description: Number of datasets that will be included after skipping. type: integer format: int32 x-ms-parameter-location: method skipQueryParameter: in: query name: skip description: Number of datasets that will be skipped. type: integer format: int32 x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'