QuestionAnsweringAuthoringClient.UpdateSynonyms Method

Definition

Namespace:

Azure.AI.Language.QuestionAnswering.Authoring

Assembly:

Azure.AI.Language.QuestionAnswering.dll

Package:

Azure.AI.Language.QuestionAnswering v1.1.0

Overloads

Name	Description
UpdateSynonyms(String, RequestContent, RequestContext)	[Protocol Method] Updates all the synonyms of a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler UpdateSynonyms(String, SynonymAssets, CancellationToken) convenience overload with strongly typed models first.

UpdateSynonyms(String, RequestContent, RequestContext)

Source:

QuestionAnsweringAuthoringClient.cs

[Protocol Method] Updates all the synonyms of a project.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler UpdateSynonyms(String, SynonymAssets, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response UpdateSynonyms(string projectName, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member UpdateSynonyms : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.UpdateSynonyms : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function UpdateSynonyms (projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

projectName

String

The name of the project to use.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

projectName or content is null.

ArgumentException

projectName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call UpdateSynonyms with required parameters.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new QuestionAnsweringAuthoringClient(endpoint, credential);

var data = new {};

Response response = client.UpdateSynonyms("<projectName>", RequestContent.Create(data));
Console.WriteLine(response.Status);

This sample shows how to call UpdateSynonyms with all parameters and request content.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new QuestionAnsweringAuthoringClient(endpoint, credential);

var data = new {
    value = new[] {
        new {
            alterations = new[] {
                "<String>"
            },
        }
    },
    nextLink = "<nextLink>",
};

Response response = client.UpdateSynonyms("<projectName>", RequestContent.Create(data));
Console.WriteLine(response.Status);

Remarks

Below is the JSON schema for the request payload. Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/cognitiveservices/questionanswering/question-answering-projects/update-synonyms

Request Body:

Schema for SynonymAssets:

{
              value: [
                {
                  alterations: [string], # Required. Collection of word alterations.
                }
              ], # Optional. Collection of synonyms.
              nextLink: string, # Optional.
            }