Share via


ConversationAnalysisClient Class

Definition

The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.

public class ConversationAnalysisClient
type ConversationAnalysisClient = class
Public Class ConversationAnalysisClient
Inheritance
ConversationAnalysisClient

Remarks

See https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime for more information about models you can pass to this client.

Constructors

ConversationAnalysisClient()

Initializes a new instance of ConversationAnalysisClient for mocking.

ConversationAnalysisClient(Uri, AzureKeyCredential, ConversationsClientOptions)

Initializes a new instance of ConversationAnalysisClient.

ConversationAnalysisClient(Uri, AzureKeyCredential)

Initializes a new instance of ConversationAnalysisClient.

ConversationAnalysisClient(Uri, TokenCredential, ConversationsClientOptions)

Initializes a new instance of ConversationAnalysisClient.

ConversationAnalysisClient(Uri, TokenCredential)

Initializes a new instance of ConversationAnalysisClient.

Properties

Endpoint

Gets the service endpoint for this client.

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AnalyzeConversation(AnalyzeConversationInput, CancellationToken)

Analyzes the input conversation utterance.

AnalyzeConversation(RequestContent, RequestContext)

[Protocol Method] Analyzes the input conversation utterance.

AnalyzeConversationAsync(AnalyzeConversationInput, CancellationToken)

Analyzes the input conversation utterance.

AnalyzeConversationAsync(RequestContent, RequestContext)

[Protocol Method] Analyzes the input conversation utterance.

AnalyzeConversations(AnalyzeConversationOperationInput, CancellationToken)

Convenience method to submit an analysis long running operation for conversations and return the response once processed.

AnalyzeConversations(WaitUntil, RequestContent, RequestContext)

[Protocol Method] Submits an analysis long running operation for conversations and return the response once processed.

AnalyzeConversationsAsync(AnalyzeConversationOperationInput, CancellationToken)

Convenience method to submit an analysis long running operation for conversations and return the response once processed.

AnalyzeConversationsAsync(WaitUntil, RequestContent, RequestContext)

[Protocol Method] Submits an analysis long running operation for conversations and return the response once processed.

AnalyzeConversationSubmitOperation(WaitUntil, AnalyzeConversationOperationInput, CancellationToken)

Analyzes the input conversation utterance.

AnalyzeConversationSubmitOperation(WaitUntil, RequestContent, RequestContext)

[Protocol Method] Analyzes the input conversation utterance.

AnalyzeConversationSubmitOperationAsync(WaitUntil, AnalyzeConversationOperationInput, CancellationToken)

Analyzes the input conversation utterance.

AnalyzeConversationSubmitOperationAsync(WaitUntil, RequestContent, RequestContext)

[Protocol Method] Analyzes the input conversation utterance.

CancelAnalyzeConversations(WaitUntil, Guid, RequestContext)

[Protocol Method] Cancel a long-running Text Analysis conversations job.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CancelAnalyzeConversationsAsync(WaitUntil, Guid, RequestContext)

[Protocol Method] Cancel a long-running Text Analysis conversations job.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAnalyzeConversationJobStatus(Guid, Nullable<Boolean>, CancellationToken)

Get analysis status and results.

GetAnalyzeConversationJobStatus(Guid, Nullable<Boolean>, RequestContext)

[Protocol Method] Get analysis status and results

GetAnalyzeConversationJobStatusAsync(Guid, Nullable<Boolean>, CancellationToken)

Get analysis status and results.

GetAnalyzeConversationJobStatusAsync(Guid, Nullable<Boolean>, RequestContext)

[Protocol Method] Get analysis status and results

Applies to