Question Answering Projects - Create Project

Service:

Azure AI Services

API-versie:

2023-04-01

Een project maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string (uri)	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld 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]$	Naam van het project.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
description	string	Beschrijving van het project.
language	string	Taal van de tekstrecords. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling.
multilingualResource	boolean	Resource ingeschakeld voor meerdere talen in projecten of niet.
settings	ProjectSettings	Configureerbare instellingen van het project.

Antwoorden

Name	Type	Description
200 OK	QuestionAnsweringProjectMetadata	De aanvraag is voltooid.
201 Created	QuestionAnsweringProjectMetadata	De aanvraag is geslaagd en er is een nieuwe resource gemaakt.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Voorbeeldrespons

Statuscode:

200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Statuscode:

201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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.
ProjectSettings	Configureerbare instellingen van het project.
QuestionAnsweringProjectMetadata	Vertegenwoordigt het project.
QuestionAnsweringProjectMetadataCreateOrUpdate	Vertegenwoordigt het project.

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
InvalidRequest	Ongeldige aanvraagfout
InvalidArgument	Ongeldig argumentfout
Unauthorized	Fout bij onbevoegde toegang
Forbidden	Fout bij verboden toegang
NotFound	Fout niet gevonden
ProjectNotFound	De fout Project is niet gevonden
OperationNotFound	Fout bij bewerking niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchIndexNotFound	Fout bij azure Cognitive Search-index is niet gevonden
TooManyRequests	Fout bij te veel aanvragen
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexlimiet bereikt fout
InternalServerError	Interne serverfout
ServiceUnavailable	Fout over niet-beschikbaar service
Timeout	Time-outfout
QuotaExceeded	Fout over overschreden quotum
Conflict	Conflict fout
Warning	Waarschuwingsfout

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidParameterValue	Fout met ongeldige parameterwaarde
KnowledgeBaseNotFound	Fout in Knowledge Base is niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
ExtractionFailure	Fout bij extractiefout
InvalidRequestBodyFormat	Fout bij ongeldige indeling van aanvraagtekst
EmptyRequest	Fout bij lege aanvraag
MissingInputDocuments	Fout bij ontbrekende invoerdocumenten
InvalidDocument	Ongeldige documentfout
ModelVersionIncorrect	Fout bij onjuiste modelversie
InvalidDocumentBatch	Ongeldige documentbatchfout
UnsupportedLanguageCode	Fout met niet-ondersteunde taalcode
InvalidCountryHint	Fout met ongeldige landhint

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.

ProjectSettings

Object

Configureerbare instellingen van het project.

Name	Type	Description
defaultAnswer	string	Standaardantwoordantwoord als er geen goede overeenkomst wordt gevonden in de Knowledge Base.

QuestionAnsweringProjectMetadata

Object

Vertegenwoordigt het project.

Name	Type	Description
createdDateTime	string (date-time)	De datum/tijd voor het maken van een project.
description	string	Beschrijving van het project.
language	string	Taal van de tekstrecords. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling.
lastDeployedDateTime	string (date-time)	Vertegenwoordigt de datum/tijd van de laatste implementatie van het project.
lastModifiedDateTime	string (date-time)	Vertegenwoordigt het laatst gewijzigde datum/tijd van het project.
multilingualResource	boolean	Resource ingeschakeld voor meerdere talen in projecten of niet.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Naam van het project.
settings	ProjectSettings	Configureerbare instellingen van het project.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

Vertegenwoordigt het project.

Name	Type	Description
description	string	Beschrijving van het project.
language	string	Taal van de tekstrecords. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling.
multilingualResource	boolean	Resource ingeschakeld voor meerdere talen in projecten of niet.
settings	ProjectSettings	Configureerbare instellingen van het project.