project

Creates, updates, deletes, gets or lists a project resource.

Overview

Name	project
Type	Resource
Id	azure.ai_language.project

Fields

The following fields are returned by SELECT queries:

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

list_trained_models

Name	Datatype	Description
hasSnapshot	boolean	The flag to indicate if the trained model has a snapshot ready. Required.
label	string	The trained model label. Required.
lastTrainedDateTime	string (date-time)	The last trained date time of the model. Required.
lastTrainingDurationInSeconds	integer	The duration of the model's last training request in seconds. Required.
modelExpirationDate	string (date)	The model expiration date. Required.
modelId	string	The model ID. Required.
modelTrainingConfigVersion	string	The model training config version. Required.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_assign_project_resources_status	select	job_id, project_name, endpoint		Gets the status of an existing assign project resources job.
list_trained_models	select	project_name, endpoint	top, skip, maxpagesize	Lists the trained models belonging to a project.
get_project_deletion_status	select	job_id, endpoint		Gets the status for a project deletion job.
list_training_jobs	exec	project_name, endpoint	top, skip, maxpagesize	Lists the non-expired training jobs created for a project.
list_project_resources	exec	project_name, endpoint	top, skip, maxpagesize	Lists the Language or AIService resources assigned to the project.
list_deployments	exec	project_name, endpoint	top, skip, maxpagesize	Lists the deployments belonging to a project.
list_exported_models	exec	project_name, endpoint	top, skip, maxpagesize	Lists the exported models belonging to a project.
get_unassign_project_resources_status	exec	job_id, project_name, endpoint		Gets the status of an existing unassign project resources job.
get_swap_deployments_status	exec	job_id, project_name, endpoint		Gets the status of an existing swap deployment job.
get_project	exec	project_name, endpoint		Gets the details of a project.
get_export_status	exec	job_id, project_name, endpoint		Gets the status of an export job. Once job completes, returns the project metadata, and assets.
get_copy_project_status	exec	job_id, project_name, endpoint		Gets the status of an existing copy project job.
get_training_status	exec	job_id, project_name, endpoint		Gets the status for a training job.
assign_project_resources	exec	project_name, endpoint, projectResources		Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory _.
unassign_project_resources	exec	project_name, endpoint		Unassign resources from a project. This disallows deployment to these resources.
swap_deployments	exec	project_name, endpoint, firstDeploymentName, secondDeploymentName		Swaps two existing deployments with each other.
import	exec	project_name, endpoint, projectFileVersion, stringIndexType, metadata	format	Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
export	exec	project_name, stringIndexType, endpoint	format, assetKind, trainedModelLabel	Triggers a job to export a project's data.
copy_project_authorization	exec	project_name, endpoint		Generates a copy project operation authorization to the current target Azure resource.
copy_project	exec	project_name, endpoint, projectKind, targetProjectName, accessToken, expiresAt, targetResourceId, targetResourceRegion		Copies an existing project to another Azure resource.
train	exec	project_name, endpoint, modelLabel, trainingMode		Triggers a training job for a project.
cancel_training_job	exec	job_id, project_name, endpoint		Triggers a cancellation for a running training job.

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: )
job_id	string	The job ID. Required.
project_name	string
stringIndexType	string	Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets _. Known values are: "Utf16CodeUnit", "Utf8CodeUnit", and "Utf32CodeUnit". Required.
assetKind	string	Kind of asset to export. Default value is None.
format	string	The format of the exported project file to use. Known values are: "Conversation" and "Luis". Default value is None.
maxpagesize	integer
skip	integer	The number of result items to skip. Default value is None.
top	integer	The number of result items to return. Default value is None.
trainedModelLabel	string	Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. Default value is None.

SELECT examples

get_assign_project_resources_status

Gets the status of an existing assign project resources job.

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

list_trained_models

Lists the trained models belonging to a project.

SELECT
hasSnapshot,
label,
lastTrainedDateTime,
lastTrainingDurationInSeconds,
modelExpirationDate,
modelId,
modelTrainingConfigVersion
FROM azure.ai_language.project
WHERE project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;

get_project_deletion_status

Gets the status for a project deletion job.

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

Lifecycle Methods

list_training_jobs

Lists the non-expired training jobs created for a project.

EXEC azure.ai_language.project.list_training_jobs 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@top='{{ top }}', 
@skip='{{ skip }}', 
@maxpagesize='{{ maxpagesize }}'
;

list_project_resources

Lists the Language or AIService resources assigned to the project.

EXEC azure.ai_language.project.list_project_resources 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@top='{{ top }}', 
@skip='{{ skip }}', 
@maxpagesize='{{ maxpagesize }}'
;

list_deployments

Lists the deployments belonging to a project.

EXEC azure.ai_language.project.list_deployments 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@top='{{ top }}', 
@skip='{{ skip }}', 
@maxpagesize='{{ maxpagesize }}'
;

list_exported_models

Lists the exported models belonging to a project.

EXEC azure.ai_language.project.list_exported_models 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@top='{{ top }}', 
@skip='{{ skip }}', 
@maxpagesize='{{ maxpagesize }}'
;

get_unassign_project_resources_status

Gets the status of an existing unassign project resources job.

EXEC azure.ai_language.project.get_unassign_project_resources_status 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_swap_deployments_status

Gets the status of an existing swap deployment job.

EXEC azure.ai_language.project.get_swap_deployments_status 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_project

Gets the details of a project.

EXEC azure.ai_language.project.get_project 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_export_status

Gets the status of an export job. Once job completes, returns the project metadata, and assets.

EXEC azure.ai_language.project.get_export_status 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_copy_project_status

Gets the status of an existing copy project job.

EXEC azure.ai_language.project.get_copy_project_status 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_training_status

Gets the status for a training job.

EXEC azure.ai_language.project.get_training_status 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

assign_project_resources

Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory _.

EXEC azure.ai_language.project.assign_project_resources 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"projectResources": "{{ projectResources }}"
}'
;

unassign_project_resources

Unassign resources from a project. This disallows deployment to these resources.

EXEC azure.ai_language.project.unassign_project_resources 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"azureResourceIds": "{{ azureResourceIds }}"
}'
;

swap_deployments

Swaps two existing deployments with each other.

EXEC azure.ai_language.project.swap_deployments 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"firstDeploymentName": "{{ firstDeploymentName }}", 
"secondDeploymentName": "{{ secondDeploymentName }}"
}'
;

import

Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.

EXEC azure.ai_language.project.import 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@format='{{ format }}' 
@@json=
'{
"projectFileVersion": "{{ projectFileVersion }}", 
"stringIndexType": "{{ stringIndexType }}", 
"metadata": "{{ metadata }}", 
"assets": "{{ assets }}"
}'
;

export

Triggers a job to export a project's data.

EXEC azure.ai_language.project.export 
@project_name='{{ project_name }}' --required, 
@stringIndexType='{{ stringIndexType }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@format='{{ format }}', 
@assetKind='{{ assetKind }}', 
@trainedModelLabel='{{ trainedModelLabel }}'
;

copy_project_authorization

Generates a copy project operation authorization to the current target Azure resource.

EXEC azure.ai_language.project.copy_project_authorization 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

copy_project

Copies an existing project to another Azure resource.

EXEC azure.ai_language.project.copy_project 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"projectKind": "{{ projectKind }}", 
"targetProjectName": "{{ targetProjectName }}", 
"accessToken": "{{ accessToken }}", 
"expiresAt": "{{ expiresAt }}", 
"targetResourceId": "{{ targetResourceId }}", 
"targetResourceRegion": "{{ targetResourceRegion }}"
}'
;

train

Triggers a training job for a project.

EXEC azure.ai_language.project.train 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"modelLabel": "{{ modelLabel }}", 
"trainingConfigVersion": "{{ trainingConfigVersion }}", 
"trainingMode": "{{ trainingMode }}", 
"evaluationOptions": "{{ evaluationOptions }}", 
"dataGenerationSettings": "{{ dataGenerationSettings }}"
}'
;

cancel_training_job

Triggers a cancellation for a running training job.

EXEC azure.ai_language.project.cancel_training_job 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;