Question Answering Projects - Update Synonyms

Service:

Azure AI Services

API Version:

2023-04-01

Updates all the synonyms of a project.

PUT {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/synonyms?api-version=2023-04-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string (uri)	Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	The name of the project to use.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
value	True	WordAlterations[]	The WordAlterations items on this page
nextLink		string (uri)	The link to the next page of items

Responses

Name	Type	Description
204 No Content		Response payload after synonyms updated successfully.
Other Status Codes	ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Examples

Successful query

Sample request

HTTP

PUT {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/synonyms?api-version=2023-04-01

{
  "value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}

Sample response

Status code:

204

Definitions

Name	Description
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.
SynonymAssets	Request payload for updating synonyms.
WordAlterations	Collection of word alterations.

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	Invalid request error
InvalidArgument	Invalid argument error
Unauthorized	Unauthorized access error
Forbidden	Forbidden access error
NotFound	Not found error
ProjectNotFound	Project not found error
OperationNotFound	Operation not found error
AzureCognitiveSearchNotFound	Azure Cognitive Search not found error
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search index not found error
TooManyRequests	Too many requests error
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search index limit reached error
InternalServerError	Internal server error
ServiceUnavailable	Service unavailable error
Timeout	Timeout error
QuotaExceeded	Quota exceeded error
Conflict	Conflict error
Warning	Warning error

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest	Invalid request error
InvalidParameterValue	Invalid parameter value error
KnowledgeBaseNotFound	Knowledge base not found error
AzureCognitiveSearchNotFound	Azure Cognitive Search not found error
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
ExtractionFailure	Extraction failure error
InvalidRequestBodyFormat	Invalid request body format error
EmptyRequest	Empty request error
MissingInputDocuments	Missing input documents error
InvalidDocument	Invalid document error
ModelVersionIncorrect	Model version incorrect error
InvalidDocumentBatch	Invalid document batch error
UnsupportedLanguageCode	Unsupported language code error
InvalidCountryHint	Invalid country hint error

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.

SynonymAssets

Object

Request payload for updating synonyms.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	WordAlterations[]	The WordAlterations items on this page

WordAlterations

Object

Collection of word alterations.

Name	Type	Description
alterations	string[]	Collection of word alterations.