Class AzureAIContentSafetyClient

Provides methods for interacting with Azure AI Content Safety services.

public class AzureAIContentSafetyClient : IAzureAIContentSafetyClient

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Initializes a new instance of the AzureAIContentSafetyClient class.

public AzureAIContentSafetyClient(Uri endpoint, AzureKeyCredential credential, APIEndpointClientOptions? options, bool enableRetry)

endpoint Uri: The endpoint URI of the Azure AI Content Safety service.
credential AzureKeyCredential: The AzureKeyCredential used to authenticate requests to the service.
options APIEndpointClientOptions: Optional configuration settings for the client, such as retry policies and timeouts.
enableRetry bool: Indicates whether to enable retry logic for transient failures.

Analyzes the specified text and returns the results of the analysis.

public Task<ClientResult<AnalyzeTextResult>> AnalyzeText(AnalyzeTextRequest request, CancellationToken cancellationToken = default)

request AnalyzeTextRequest: The request containing the text to analyze.
cancellationToken CancellationToken: The optional cancellation token used to signal a cancellation request.

Task<ClientResult<AnalyzeTextResult>>: A task that represents the asynchronous operation. The task result contains an System.ClientModel.ClientResult object with the results of the analysis.

Creates and configures a new instance of the AzureAIContentSafetyClient.

public static IAzureAIContentSafetyClient BuildClient(Dictionary<string, object> clientBuilderParameters)

clientBuilderParameters Dictionary<string, object>: A dictionary of parameters used to further configure the client.

IAzureAIContentSafetyClient: A new instance of the AzureAIContentSafetyClient configured with the specified clientBuilderParameters.

Analyzes a user prompt and associated documents for various prompt attacks.

public Task<ClientResult<ShieldPromptResult>> ShieldPrompt(ShieldPromptRequest request, CancellationToken cancellationToken = default)

request ShieldPromptRequest: The request containing the user prompt and associated documents.
cancellationToken CancellationToken: The optional cancellation token used to signal a cancellation request.

Task<ClientResult<ShieldPromptResult>>: A task that represents the asynchronous operation. The task result contains an System.ClientModel.ClientResult object with the results of the analysis.