exported_model

Creates, updates, deletes, gets or lists an exported_model resource.

Overview

Name	exported_model
Type	Resource
Id	azure.ai_language.exported_model

Fields

The following fields are returned by SELECT queries:

get_exported_model_job_status

Name	Datatype	Description
createdDateTime	string (date-time)	The creation date time of the job. Required.
errors	array	The errors encountered while executing the job.
expirationDateTime	string (date-time)	The expiration date time of the job.
jobId	string	The job ID. Required.
lastUpdatedDateTime	string (date-time)	The last date time the job was updated. Required.
status	string	The job status. Required. Known values are: "notStarted", "running", "succeeded", "failed", "cancelled", "cancelling", and "partiallyCompleted". (notStarted, running, succeeded, failed, cancelled, cancelling, partiallyCompleted)
warnings	array	The warnings that were encountered while executing the job.

get_exported_model

Name	Datatype	Description
exportedModelName	string	The exported model name. Required.
lastExportedModelDateTime	string (date-time)	The last exported date time of the model. Required.
lastTrainedDateTime	string (date-time)	The last trained date time of the model. Required.
modelExpirationDate	string (date)	The model expiration date. Required.
modelId	string	The model ID. Required.
modelTrainingConfigVersion	string	The model training config version. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_exported_model_job_status	select	exported_model_name, job_id, project_name, endpoint		Gets the status for an existing job to create or update an exported model.
get_exported_model	select	exported_model_name, project_name, endpoint		Gets the details of an exported model.
create_or_update_exported_model	insert	exported_model_name, project_name, endpoint, trainedModelLabel		Creates a new exported model or replaces an existing one.
create_or_update_exported_model	replace	exported_model_name, project_name, endpoint, trainedModelLabel		Creates a new exported model or replaces an existing one.
delete_exported_model	delete	exported_model_name, project_name, endpoint		Deletes an existing exported model.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client Endpoint parameter. (default: )
exported_model_name	string	The exported model name. Required.
job_id	string	The job ID. Required.
project_name	string

SELECT examples

get_exported_model_job_status

Gets the status for an existing job to create or update an exported model.

SELECT
createdDateTime,
errors,
expirationDateTime,
jobId,
lastUpdatedDateTime,
status,
warnings
FROM azure.ai_language.exported_model
WHERE exported_model_name = '{{ exported_model_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_exported_model

Gets the details of an exported model.

SELECT
exportedModelName,
lastExportedModelDateTime,
lastTrainedDateTime,
modelExpirationDate,
modelId,
modelTrainingConfigVersion
FROM azure.ai_language.exported_model
WHERE exported_model_name = '{{ exported_model_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_exported_model

Creates a new exported model or replaces an existing one.

INSERT INTO azure.ai_language.exported_model (
trainedModelLabel,
exported_model_name,
project_name,
endpoint
)
SELECT 
'{{ trainedModelLabel }}' /* required */,
'{{ exported_model_name }}',
'{{ project_name }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: exported_model
props:
  - name: exported_model_name
    value: "{{ exported_model_name }}"
    description: Required parameter for the exported_model resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the exported_model resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the exported_model resource.
  - name: trainedModelLabel
    value: "{{ trainedModelLabel }}"
    description: |
      The trained model label. Required.

REPLACE examples

create_or_update_exported_model

Creates a new exported model or replaces an existing one.

REPLACE azure.ai_language.exported_model
SET 
trainedModelLabel = '{{ trainedModelLabel }}'
WHERE 
exported_model_name = '{{ exported_model_name }}' --required
AND project_name = '{{ project_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND trainedModelLabel = '{{ trainedModelLabel }}' --required;

DELETE examples

delete_exported_model

Deletes an existing exported model.

DELETE FROM azure.ai_language.exported_model
WHERE exported_model_name = '{{ exported_model_name }}' --required
AND project_name = '{{ project_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;