Microsoft Cognitive Language Service - Analyze Conversations (preview:2021-11-01)

2025/07/24 • 1 deleted methods

ConversationAnalysis_AnalyzeConversation (removed)
Description :  Analyzes the input conversation utterance.
Reference :  Link ¶

⚼ Request

POST:  /:analyze-conversations
{
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
ConversationAnalysisOptions:
{
Description: Post body of the request. ,
Required: True ,
}
{
query:
{
Description: The conversation utterance to be analyzed. ,
Required: True ,
}
string ,
directTarget:
{
Description: The name of the target project this request is sending to directly. ,
Required: False ,
}
string ,
language:
{
Description: The language to use in this request. This will be the language setting when communicating with all other target projects. ,
Required: False ,
}
string ,
verbose:
{
Description: If true, the service will return more detailed information in the response. ,
Required: False ,
}
boolean ,
isLoggingEnabled:
{
Description: If true, the query will be kept by the service for customers to further review, to improve the model quality. ,
Required: False ,
}
boolean ,
parameters:
{
Description: A dictionary representing the input for each target project. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
query:
{
Description: The conversation utterance given by the caller. ,
Required: True ,
}
string ,
detectedLanguage:
{
Description: The system detected language for the query. ,
Required: False ,
}
string ,
prediction:
{
Description: The prediction result of a conversation project. ,
Required: True ,
}
{
projectKind:
{
Description: The type of the project. ,
Enum:
{
conversation: No description available. ,
workflow: No description available. ,
}
,
Required: True ,
}
enum ,
topIntent:
{
Description: The intent with the highest score. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidArgument: No description available. ,
Unauthorized: No description available. ,
Forbidden: No description available. ,
NotFound: No description available. ,
TooManyRequests: No description available. ,
InternalServerError: No description available. ,
ServiceUnavailable: No description available. ,
ProjectNotFound: No description available. ,
OperationNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchIndexNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
AzureCognitiveSearchIndexLimitReached: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: No description available. ,
InvalidParameterValue: No description available. ,
KnowledgeBaseNotFound: No description available. ,
AzureCognitiveSearchNotFound: No description available. ,
AzureCognitiveSearchThrottling: No description available. ,
ExtractionFailure: No description available. ,
InvalidRequestBodyFormat: No description available. ,
EmptyRequest: No description available. ,
MissingInputDocuments: No description available. ,
InvalidDocument: No description available. ,
ModelVersionIncorrect: No description available. ,
InvalidDocumentBatch: No description available. ,
UnsupportedLanguageCode: No description available. ,
InvalidCountryHint: No description available. ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}