question_answering_projects

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

Overview

Name	question_answering_projects
Type	Resource
Id	azure.ai_language.question_answering_projects

Fields

The following fields are returned by SELECT queries:

list_projects

Name	Datatype	Description
configureSemanticRanking	boolean	Represents if semantic ranking is configured.
createdDateTime	string (date-time)	Project creation date-time.
description	string	Description of the project.
language	string	Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default.
lastDeployedDateTime	string (date-time)	Represents the project last deployment date-time.
lastModifiedDateTime	string (date-time)	Represents the project last modified date-time.
multilingualResource	boolean	Resource enabled for multiple languages across projects or not.
projectName	string	Name of the project. Required.
settings	object	Configurable settings of the Project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_projects	select	endpoint	top, skip, maxpagesize	Gets all projects for a user.
delete_project	delete	project_name, endpoint		Delete the project.
create_project	exec	project_name, endpoint		Create or update a project.

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	Name of the project. Required.
maxpagesize	integer
skip	integer	An offset into the collection of the first resource to be returned. Default value is None.
top	integer	The maximum number of resources to return from the collection. Default value is None.

SELECT examples

list_projects

Gets all projects for a user.

SELECT
configureSemanticRanking,
createdDateTime,
description,
language,
lastDeployedDateTime,
lastModifiedDateTime,
multilingualResource,
projectName,
settings
FROM azure.ai_language.question_answering_projects
WHERE endpoint = '{{ endpoint }}' -- required
AND top = '{{ top }}'
AND skip = '{{ skip }}'
AND maxpagesize = '{{ maxpagesize }}'
;

DELETE examples

delete_project

Delete the project.

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

Lifecycle Methods

create_project

Create or update a project.

EXEC azure.ai_language.question_answering_projects.create_project 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"description": "{{ description }}", 
"language": "{{ language }}", 
"multilingualResource": {{ multilingualResource }}, 
"settings": "{{ settings }}", 
"configureSemanticRanking": {{ configureSemanticRanking }}
}'
;