swagger_client.CustomSpeechEndpointsApi

All URIs are relative to https://localhost

Method	HTTP request	Description
create_endpoint	POST /endpoints	Creates a new endpoint.
delete_base_model_log	DELETE /endpoints/base/{locale}/files/logs/{logId}	Deletes one audio or transcription log that have been stored when using the default base model of a given language.
delete_base_model_logs	DELETE /endpoints/base/{locale}/files/logs	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.
delete_endpoint	DELETE /endpoints/{id}	Deletes the endpoint identified by the given ID.
delete_endpoint_log	DELETE /endpoints/{id}/files/logs/{logId}	Deletes one audio or transcription log that have been stored for a given endpoint.
delete_endpoint_logs	DELETE /endpoints/{id}/files/logs	Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.
get_base_model_log	GET /endpoints/base/{locale}/files/logs/{logId}	Gets a specific audio or transcription log for the default base model in a given language.
get_base_model_logs	GET /endpoints/base/{locale}/files/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	GET /endpoints/{id}	Gets the endpoint identified by the given ID.
get_endpoint_log	GET /endpoints/{id}/files/logs/{logId}	Gets a specific audio or transcription log for a given endpoint.
get_endpoint_logs	GET /endpoints/{id}/files/logs	Gets the list of audio and transcription logs that have been stored for a given endpoint.
get_endpoints	GET /endpoints	Gets the list of endpoints for the authenticated subscription.
get_supported_locales_for_endpoints	GET /endpoints/locales	Gets a list of supported locales for endpoint creations.
update_endpoint	PATCH /endpoints/{id}	Updates the metadata of the endpoint identified by the given ID.

create_endpoint

Endpoint create_endpoint(endpoint)

Creates a new endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
endpoint = swagger_client.Endpoint() # Endpoint | The details of the endpoint.

try:
    # Creates a new endpoint.
    api_response = api_instance.create_endpoint(endpoint)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->create_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
endpoint	Endpoint	The details of the endpoint.

Return type

Endpoint

Authorization

api_key, token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_base_model_log

delete_base_model_log(locale, log_id)

Deletes one audio or transcription log that have been stored when using the default base model of a given language.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
locale = 'locale_example' # str | The language used to select the default base model.
log_id = 'log_id_example' # str | The identifier of the log.

try:
    # Deletes one audio or transcription log that have been stored when using the default base model of a given language.
    api_instance.delete_base_model_log(locale, log_id)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->delete_base_model_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The language used to select the default base model.
log_id	str	The identifier of the log.

Return type

void (empty response body)

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_base_model_logs

delete_base_model_logs(locale, end_date=end_date)

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.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
locale = 'locale_example' # str | The language used to select the default base model.
end_date = 'end_date_example' # str | The end date of the audio logs deletion (specific day, UTC).              Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.              Deletes all existing logs when date is not specified. (optional)

try:
    # 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.
    api_instance.delete_base_model_logs(locale, end_date=end_date)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->delete_base_model_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The language used to select the default base model.
end_date	str	The end date of the audio logs deletion (specific day, UTC). Expected format: "yyyy-mm-dd". For instance, "2019-09-20" results in deleting all logs on September 20h, 2019 and before. Deletes all existing logs when date is not specified.	[optional]

Return type

void (empty response body)

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_endpoint

delete_endpoint(id)

Deletes the endpoint identified by the given ID.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.

try:
    # Deletes the endpoint identified by the given ID.
    api_instance.delete_endpoint(id)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->delete_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.

Return type

void (empty response body)

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_endpoint_log

delete_endpoint_log(id, log_id)

Deletes one audio or transcription log that have been stored for a given endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.
log_id = 'log_id_example' # str | The identifier of the log.

try:
    # Deletes one audio or transcription log that have been stored for a given endpoint.
    api_instance.delete_endpoint_log(id, log_id)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->delete_endpoint_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.
log_id	str	The identifier of the log.

Return type

void (empty response body)

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_endpoint_logs

delete_endpoint_logs(id, end_date=end_date)

Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.

The deletion process is done asynchronously and can take up to one day depending on the amount of log files.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.
end_date = 'end_date_example' # str | The end date of the audio logs deletion (specific day, UTC).              Expected format: \"yyyy-mm-dd\". For instance, \"2019-09-20\" results in deleting all logs on September 20h, 2019 and before.              Deletes all existing logs when date is not specified. (optional)

try:
    # Deletes the specified audio and transcription logs that have been stored for a given endpoint. It deletes all logs before (and including) a specific day.
    api_instance.delete_endpoint_logs(id, end_date=end_date)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->delete_endpoint_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.
end_date	str	The end date of the audio logs deletion (specific day, UTC). Expected format: "yyyy-mm-dd". For instance, "2019-09-20" results in deleting all logs on September 20h, 2019 and before. Deletes all existing logs when date is not specified.	[optional]

Return type

void (empty response body)

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_base_model_log

File get_base_model_log(locale, log_id, sas_validity_in_seconds=sas_validity_in_seconds)

Gets a specific audio or transcription log for the default base model in a given language.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
locale = 'locale_example' # str | The language used to select the default base model.
log_id = 'log_id_example' # str | The identifier of the log.
sas_validity_in_seconds = 56 # int | The duration in seconds that an SAS url should be valid. The default duration is 12 hours.              When using BYOS (https://docs.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. (optional)

try:
    # Gets a specific audio or transcription log for the default base model in a given language.
    api_response = api_instance.get_base_model_log(locale, log_id, sas_validity_in_seconds=sas_validity_in_seconds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_base_model_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The language used to select the default base model.
log_id	str	The identifier of the log.
sas_validity_in_seconds	int	The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://docs.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.	[optional]

Return type

File

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_base_model_logs

PaginatedFiles get_base_model_logs(locale, sas_validity_in_seconds=sas_validity_in_seconds, skip_token=skip_token, top=top)

Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
locale = 'locale_example' # str | The language used to select the default base model.
sas_validity_in_seconds = 56 # int | The duration in seconds that an SAS url should be valid. The default duration is 12 hours.              When using BYOS (https://docs.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. (optional)
skip_token = 'skip_token_example' # str | Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined. (optional)
top = 56 # int | Number of datasets that will be included after skipping. (optional)

try:
    # Gets the list of audio and transcription logs that have been stored when using the default base model of a given language.
    api_response = api_instance.get_base_model_logs(locale, sas_validity_in_seconds=sas_validity_in_seconds, skip_token=skip_token, top=top)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_base_model_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The language used to select the default base model.
sas_validity_in_seconds	int	The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://docs.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.	[optional]
skip_token	str	Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.	[optional]
top	int	Number of datasets that will be included after skipping.	[optional]

Return type

PaginatedFiles

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_endpoint

Endpoint get_endpoint(id)

Gets the endpoint identified by the given ID.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.

try:
    # Gets the endpoint identified by the given ID.
    api_response = api_instance.get_endpoint(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.

Return type

Endpoint

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_endpoint_log

File get_endpoint_log(id, log_id, sas_validity_in_seconds=sas_validity_in_seconds)

Gets a specific audio or transcription log for a given endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.
log_id = 'log_id_example' # str | The identifier of the log.
sas_validity_in_seconds = 56 # int | The duration in seconds that an SAS url should be valid. The default duration is 12 hours.              When using BYOS (https://docs.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. (optional)

try:
    # Gets a specific audio or transcription log for a given endpoint.
    api_response = api_instance.get_endpoint_log(id, log_id, sas_validity_in_seconds=sas_validity_in_seconds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_endpoint_log: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.
log_id	str	The identifier of the log.
sas_validity_in_seconds	int	The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://docs.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.	[optional]

Return type

File

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_endpoint_logs

PaginatedFiles get_endpoint_logs(id, sas_validity_in_seconds=sas_validity_in_seconds, skip_token=skip_token, top=top)

Gets the list of audio and transcription logs that have been stored for a given endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.
sas_validity_in_seconds = 56 # int | The duration in seconds that an SAS url should be valid. The default duration is 12 hours.              When using BYOS (https://docs.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. (optional)
skip_token = 'skip_token_example' # str | Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined. (optional)
top = 56 # int | Number of datasets that will be included after skipping. (optional)

try:
    # Gets the list of audio and transcription logs that have been stored for a given endpoint.
    api_response = api_instance.get_endpoint_logs(id, sas_validity_in_seconds=sas_validity_in_seconds, skip_token=skip_token, top=top)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_endpoint_logs: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.
sas_validity_in_seconds	int	The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://docs.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.	[optional]
skip_token	str	Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.	[optional]
top	int	Number of datasets that will be included after skipping.	[optional]

Return type

PaginatedFiles

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_endpoints

PaginatedEndpoints get_endpoints(skip=skip, top=top)

Gets the list of endpoints for the authenticated subscription.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
skip = 56 # int | Number of datasets that will be skipped. (optional)
top = 56 # int | Number of datasets that will be included after skipping. (optional)

try:
    # Gets the list of endpoints for the authenticated subscription.
    api_response = api_instance.get_endpoints(skip=skip, top=top)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_endpoints: %s\n" % e)

Parameters

Name	Type	Description	Notes
skip	int	Number of datasets that will be skipped.	[optional]
top	int	Number of datasets that will be included after skipping.	[optional]

Return type

PaginatedEndpoints

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_supported_locales_for_endpoints

list[str] get_supported_locales_for_endpoints()

Gets a list of supported locales for endpoint creations.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))

try:
    # Gets a list of supported locales for endpoint creations.
    api_response = api_instance.get_supported_locales_for_endpoints()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->get_supported_locales_for_endpoints: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[str]

Authorization

api_key, token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_endpoint

Endpoint update_endpoint(id, endpoint_update)

Updates the metadata of the endpoint identified by the given ID.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = swagger_client.Configuration()
configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: token
configuration = swagger_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CustomSpeechEndpointsApi(swagger_client.ApiClient(configuration))
id = 'id_example' # str | The identifier of the endpoint.
endpoint_update = swagger_client.EndpointUpdate() # EndpointUpdate | The updated values for the endpoint.

try:
    # Updates the metadata of the endpoint identified by the given ID.
    api_response = api_instance.update_endpoint(id, endpoint_update)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomSpeechEndpointsApi->update_endpoint: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	The identifier of the endpoint.
endpoint_update	EndpointUpdate	The updated values for the endpoint.

Return type

Endpoint

Authorization

api_key, token

HTTP request headers

Content-Type: application/json, application/merge-patch+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CustomSpeechEndpointsApi.md

Latest commit

History

CustomSpeechEndpointsApi.md

File metadata and controls

swagger_client.CustomSpeechEndpointsApi

create_endpoint

Example

Parameters

Return type

Authorization

HTTP request headers

delete_base_model_log

Example

Parameters

Return type

Authorization

HTTP request headers

delete_base_model_logs

Example

Parameters

Return type

Authorization

HTTP request headers

delete_endpoint

Example

Parameters

Return type

Authorization

HTTP request headers

delete_endpoint_log

Example

Parameters

Return type

Authorization

HTTP request headers

delete_endpoint_logs

Example

Parameters

Return type

Authorization

HTTP request headers

get_base_model_log

Example

Parameters

Return type

Authorization

HTTP request headers

get_base_model_logs

Example

Parameters

Return type

Authorization

HTTP request headers

get_endpoint

Example

Parameters

Return type

Authorization

HTTP request headers

get_endpoint_log

Example

Parameters

Return type

Authorization

HTTP request headers

get_endpoint_logs

Example

Parameters

Return type

Authorization

HTTP request headers

get_endpoints

Example

Parameters

Return type

Authorization

HTTP request headers

get_supported_locales_for_endpoints