Conversational Analysis Authoring - List Projects

Service:

Azure AI Services

API Version:

2022-05-01

Lists the existing projects.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://<resource-name>.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.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

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

Security

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=2022-05-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

Object

Represents the metadata of a project.

Name	Type	Description
createdDateTime	string (date-time)	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 (date-time)	Represents the project last deployed datetime.
lastModifiedDateTime	string (date-time)	Represents the project creation datetime.
lastTrainedDateTime	string (date-time)	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

Object

Represents the settings used to define the project behavior.

Name	Type	Description
confidenceThreshold	number (float)	The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to "None".

ConversationalAnalysisAuthoringProjectsMetadata

Object

Represents a list of retrieved projects' metadata.

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

Error

Object

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

Enumeration

Human-readable error code.

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

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Object

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.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

ProjectKind

Enumeration

Represents the project kind.

Value	Description
Conversation	A project to build natural language into apps, bots, and IoT devices.
Orchestration	A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project.