Conversational Analysis Authoring - List Projects

Reference

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Lists the existing projects.

GET {Endpoint}/language/authoring/analyze-conversations/projects?api-version=2023-04-01

With optional parameters:

GET {Endpoint}/language/authoring/analyze-conversations/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client API version.
maxpagesize	query		integer int32	The maximum number of resources to include in a single response.
skip	query		integer int32	An offset into the collection of the first resource to be returned.
top	query		integer int32	The maximum number of resources to return from the collection.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectsMetadata	The metadata of projects.
Other Status Codes	ErrorResponse	Error response.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful List Projects

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "createdDateTime": "2022-04-18T14:03:16Z",
      "lastModifiedDateTime": "2022-04-18T14:03:16Z",
      "projectKind": "Conversation",
      "projectName": "myproject1",
      "multilingual": false,
      "description": "This is a sample conversation project.",
      "language": "en"
    },
    {
      "createdDateTime": "2022-04-18T14:03:12Z",
      "lastModifiedDateTime": "2022-04-18T14:03:12Z",
      "projectKind": "Conversation",
      "projectName": "myproject",
      "multilingual": false,
      "description": "This is a sample conversation project.",
      "language": "en"
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
ConversationalAnalysisAuthoringProjectMetadata	Represents the metadata of a project.
ConversationalAnalysisAuthoringProjectSettings	Represents the settings used to define the project behavior.
ConversationalAnalysisAuthoringProjectsMetadata	Represents a list of retrieved projects' metadata.
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Represents the project kind.

ConversationalAnalysisAuthoringProjectMetadata

Represents the metadata of a project.

Name	Type	Description
createdDateTime	string	Represents the project creation datetime.
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.
lastDeployedDateTime	string	Represents the project last deployed datetime.
lastModifiedDateTime	string	Represents the project creation datetime.
lastTrainedDateTime	string	Represents the project last trained datetime.
multilingual	boolean	Whether the project would be used for multiple languages or not.
projectKind	ProjectKind	Represents the project kind.
projectName	string	The new project name.
settings	ConversationalAnalysisAuthoringProjectSettings	The project settings.

ConversationalAnalysisAuthoringProjectSettings

Represents the settings used to define the project behavior.

Name	Type	Description
confidenceThreshold	number	The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive.

ConversationalAnalysisAuthoringProjectsMetadata

Represents a list of retrieved projects' metadata.

Name	Type	Description
nextLink	string	The next page link.
value	ConversationalAnalysisAuthoringProjectMetadata[]	The list of projects.

Error

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Human-readable error code.

Name	Type	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode