projects

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

Overview

Name	projects
Type	Resource
Id	azure.ai_text_analytics_authoring.projects

Fields

The following fields are returned by SELECT queries:

list_projects

Name	Datatype	Description
createdDateTime	string (date-time)	Represents the project creation datetime. Required.
description	string	The project description.
language	string	The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. Required.
lastDeployedDateTime	string (date-time)	Represents the project last deployment datetime.
lastModifiedDateTime	string (date-time)	Represents the project last modification datetime. Required.
lastTrainedDateTime	string (date-time)	Represents the project last training datetime.
multilingual	boolean	Whether the project would be used for multiple languages or not.
projectKind	string	The project kind. Required. Known values are: "CustomSingleLabelClassification", "CustomMultiLabelClassification", "CustomEntityRecognition", "CustomAbstractiveSummarization", "CustomHealthcare", and "CustomTextSentiment". (CustomSingleLabelClassification, CustomMultiLabelClassification, CustomEntityRecognition, CustomAbstractiveSummarization, CustomHealthcare, CustomTextSentiment)
projectName	string	The new project name. Required.
settings	object	The project settings.
storageInputContainerName	string	The storage container name. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_projects	select	endpoint	top, skip, maxpagesize	Lists the existing projects.
delete_project	delete	project_name, endpoint		Deletes a project.
create_project	exec	project_name, endpoint, projectKind, storageInputContainerName, projectName, language		The most basic operation that applies to a resource.

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: )
project_name	string	The new project name. Required.
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.

SELECT examples

list_projects

Lists the existing projects.

SELECT
createdDateTime,
description,
language,
lastDeployedDateTime,
lastModifiedDateTime,
lastTrainedDateTime,
multilingual,
projectKind,
projectName,
settings,
storageInputContainerName
FROM azure.ai_text_analytics_authoring.projects
WHERE endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;

DELETE examples

delete_project

Deletes a project.

DELETE FROM azure.ai_text_analytics_authoring.projects
WHERE project_name = '{{ project_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

create_project

The most basic operation that applies to a resource.

EXEC azure.ai_text_analytics_authoring.projects.create_project 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"projectKind": "{{ projectKind }}", 
"storageInputContainerName": "{{ storageInputContainerName }}", 
"settings": "{{ settings }}", 
"projectName": "{{ projectName }}", 
"multilingual": {{ multilingual }}, 
"description": "{{ description }}", 
"language": "{{ language }}"
}'
;