Question Answering Projects - Get Synonyms

Service:

Azure AI Services

API-versie:

2021-10-01

Hiermee haalt u alle synoniemen van een project op.

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

Met optionele parameters:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.
maxpagesize	query		integer (int32)	Het maximum aantal resources dat in één antwoord moet worden opgenomen.
skip	query		integer (int32)	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
top	query		integer (int32)	Het maximum aantal resources dat moet worden geretourneerd uit de verzameling.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	SynonymAssets	Alle synoniemen van een project.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Alle synoniemenassets voor dit project.
WordAlterations	Verzameling woordwijzigingen.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

SynonymAssets

Object

Alle synoniemenassets voor dit project.

Name	Type	Description
nextLink	string
value	WordAlterations[]	Verzameling synoniemen.

WordAlterations

Object

Verzameling woordwijzigingen.

Name	Type	Description
alterations	string[]	Verzameling woordwijzigingen.