Question Answering Projects - Create Project

Servizio:

Azure AI Services

Versione API:

2023-04-01

Creare o aggiornare un progetto.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string (uri)	Endpoint di Servizi cognitivi supportato, ad esempio https://< nome-risorsa.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]$	Nome del progetto.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Lingua dei record di testo. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
multilingualResource	boolean	Risorsa abilitata per più lingue tra progetti o meno.
settings	ProjectSettings	Impostazioni configurabili del progetto.

Risposte

Nome	Tipo	Descrizione
200 OK	QuestionAnsweringProjectMetadata	La richiesta è andata a buon fine.
201 Created	QuestionAnsweringProjectMetadata	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.
Other Status Codes	ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Successful query

Esempio di richiesta

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"
}

Risposta di esempio

Codice di stato:

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"
}

Codice di stato:

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"
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Impostazioni configurabili del progetto.
QuestionAnsweringProjectMetadata	Rappresenta il progetto.
QuestionAnsweringProjectMetadataCreateOrUpdate	Rappresenta il progetto.

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
InvalidRequest	Errore di richiesta non valido
InvalidArgument	Errore di argomento non valido
Unauthorized	Errore di accesso non autorizzato
Forbidden	Errore di accesso negato
NotFound	Errore non trovato
ProjectNotFound	Errore di progetto non trovato
OperationNotFound	Errore di operazione non trovata
AzureCognitiveSearchNotFound	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchIndexNotFound	Errore non trovato nell'indice di Ricerca cognitiva di Azure
TooManyRequests	Errore di troppe richieste
AzureCognitiveSearchThrottling	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
AzureCognitiveSearchIndexLimitReached	Errore raggiunto dal limite di indice di Ricerca cognitiva di Azure
InternalServerError	Errore interno del server
ServiceUnavailable	Errore di servizio non disponibile
Timeout	Errore di timeout
QuotaExceeded	Errore di superamento della quota
Conflict	Errore di conflitto
Warning	Errore di avviso

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
InvalidRequest	Errore di richiesta non valido
InvalidParameterValue	Errore del valore del parametro non valido
KnowledgeBaseNotFound	Errore della Knowledge Base non trovato
AzureCognitiveSearchNotFound	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchThrottling	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
ExtractionFailure	Errore di estrazione
InvalidRequestBodyFormat	Errore di formato del corpo della richiesta non valido
EmptyRequest	Errore di richiesta vuota
MissingInputDocuments	Errore dei documenti di input mancanti
InvalidDocument	Errore del documento non valido
ModelVersionIncorrect	Errore di versione del modello non corretto
InvalidDocumentBatch	Errore del batch di documenti non valido
UnsupportedLanguageCode	Errore di codice della lingua non supportato
InvalidCountryHint	Errore di hint paese non valido

InnerErrorModel

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

ProjectSettings

Object

Impostazioni configurabili del progetto.

Nome	Tipo	Descrizione
defaultAnswer	string	Risposta predefinita quando non viene trovata alcuna corrispondenza valida nella Knowledge Base.

QuestionAnsweringProjectMetadata

Object

Rappresenta il progetto.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Data/ora di creazione del progetto.
description	string	Descrizione del progetto.
language	string	Lingua dei record di testo. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
lastDeployedDateTime	string (date-time)	Rappresenta l'ultima data di distribuzione del progetto.
lastModifiedDateTime	string (date-time)	Rappresenta l'ultima data/ora dell'ultima modifica del progetto.
multilingualResource	boolean	Risorsa abilitata per più lingue tra progetti o meno.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nome del progetto.
settings	ProjectSettings	Impostazioni configurabili del progetto.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

Rappresenta il progetto.

Nome	Tipo	Descrizione
description	string	Descrizione del progetto.
language	string	Lingua dei record di testo. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
multilingualResource	boolean	Risorsa abilitata per più lingue tra progetti o meno.
settings	ProjectSettings	Impostazioni configurabili del progetto.