Compartilhar via

Question Answering Projects - Update Synonyms

  • Reference
Service:
Azure AI Services
API Version:
2021-10-01

Updates all the synonyms of a project.

PUT {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName
 path True

string

The name of the project to use.
api-version
 query True

string

Client API version.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
nextLink

string

value

WordAlterations[]

Collection of synonyms.

Responses

Name Type Description
204 No Content

Synonyms update successfully.
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

PUT {Endpoint}/language/query-knowledgebases/projects/proj1/synonyms?api-version=2021-10-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

All synonym assets for this project.
WordAlterations

Collection of word alterations.

Error

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

Human-readable error code.

Name Type Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

ErrorResponse

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

ExtractionFailure

string

InvalidParameterValue

string

InvalidRequest

string

KnowledgeBaseNotFound

string

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.

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

All synonym assets for this project.

Name Type Description
nextLink

string

value

WordAlterations[]

Collection of synonyms.

WordAlterations

Collection of word alterations.

Name Type Description
alterations

string[]

Collection of word alterations.