Question Answering Projects - Create Project

Service:

Azure AI Services

API-versie:

2021-10-01

Een project maken of bijwerken.

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

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.

Aanvraagkoptekst

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

Aanvraagbody

Name	Vereist	Type	Description
language	True	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.
description		string	Beschrijving van het project.
multilingualResource		boolean	Ingesteld op waar om het maken van knowledgebases in verschillende talen voor dezelfde resource mogelijk te maken.
settings		ProjectSettings	Configureerbare instellingen van het project.

Antwoorden

Name	Type	Description
200 OK	ProjectMetadata	De metagegevens van het bijgewerkte project, als het al bestaat.
201 Created	ProjectMetadata	De metagegevens van het gemaakte project, als dit niet bestaat.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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


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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Definities

Name	Description
CreateProjectOptions	Parameters die nodig zijn om het project te maken.
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.
ProjectMetadata	Vertegenwoordigt het project.
ProjectSettings	Configureerbare instellingen van het project.

CreateProjectOptions

Object

Parameters die nodig zijn om het project te maken.

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	Ingesteld op waar om het maken van knowledgebases in verschillende talen voor dezelfde resource mogelijk te maken.
settings	ProjectSettings	Configureerbare instellingen van 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
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.

ProjectMetadata

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	Naam van het project.
settings	ProjectSettings	Configureerbare instellingen van het project.

ProjectSettings

Object

Configureerbare instellingen van het project.

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