Question Answering Projects - Update Synonyms

Tjänst:

Azure AI Services

API-version:

2023-04-01

Uppdaterar alla synonymer för ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string (uri)	Cognitive Services-slutpunkt som stöds (t.ex. https://.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]$	Namnet på projektet som ska användas.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
value	True	WordAlterations[]	WordAlterations-objekten på den här sidan
nextLink		string (uri)	Länken till nästa sida med objekt

Svar

Name	Typ	Description
204 No Content		Svarsnyttolast efter att synonymerna har uppdaterats.
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Successful query

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

204

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Begär nyttolast för uppdatering av synonymer.
WordAlterations	Samling ordändringar.

Error

Objekt

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexgränsen nådde fel
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search-indexet hittades inte
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
Conflict	Konfliktfelmeddelande
Forbidden	Fel om förbjuden åtkomst
InternalServerError	Internt serverfel.
InvalidArgument	Ogiltigt argumentfel
InvalidRequest	Ogiltigt begärandefel
NotFound	Det gick inte att hitta felet
OperationNotFound	Det gick inte att hitta åtgärden
ProjectNotFound	Det gick inte att hitta projektet
QuotaExceeded	Fel om överskriden kvot
ServiceUnavailable	Fel som inte är tillgänglig för tjänsten
Timeout	Timeout-fel
TooManyRequests	Fel vid för många begäranden
Unauthorized	Fel vid obehörig åtkomst
Warning	Varningsfel

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
EmptyRequest	Fel vid tom begäran
ExtractionFailure	Fel vid extrahering
InvalidCountryHint	Ogiltigt landtipsfel
InvalidDocument	Ogiltigt dokumentfel
InvalidDocumentBatch	Ogiltigt dokumentbatchfel
InvalidParameterValue	Ogiltigt parametervärdefel
InvalidRequest	Ogiltigt begärandefel
InvalidRequestBodyFormat	Ogiltigt fel i brödtextformat för begäran
KnowledgeBaseNotFound	Det gick inte att hitta kunskapsbasen
MissingInputDocuments	Fel i indatadokument saknas
ModelVersionIncorrect	Fel i modellversion
UnsupportedLanguageCode	Fel med språkkod som inte stöds

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

SynonymAssets

Objekt

Begär nyttolast för uppdatering av synonymer.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	WordAlterations[]	WordAlterations-objekten på den här sidan

WordAlterations

Objekt

Samling ordändringar.

Name	Typ	Description
alterations	string[]	Samling ordändringar.