Compartilhar via

Question Answering Projects - Create Project

  • Reference
Service:
Azure AI Services
API Version:
2021-10-01

Create or update a project.

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

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName
 path True

string

The name of the project to use.
api-version
 query True

string

Client API version.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Required Type Description
language True

string

Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default.
description

string

Description of the project.
multilingualResource

boolean

Set to true to enable creating knowledgebases in different languages for the same resource.
settings

ProjectSettings

Configurable settings of the Project.

Responses

Name Type Description
200 OK

ProjectMetadata

The metadata of the updated project, if it already exists.
201 Created

ProjectMetadata

The metadata of the created project, if it doesn't exist.
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

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
}

Sample response

Status code:
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"
}
Status code:
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"
}

Definitions

Name Description
CreateProjectOptions

Parameters needed to create the project.
Error

The error object.
ErrorCode

Human-readable error code.
ErrorResponse

Error response.
InnerErrorCode

Human-readable error code.
InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata

Represents the project.
ProjectSettings

Configurable settings of the Project.

CreateProjectOptions

Parameters needed to create the project.

Name Type Description
description

string

Description of the project.
language

string

Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default.
multilingualResource

boolean

Set to true to enable creating knowledgebases in different languages for the same resource.
settings

ProjectSettings

Configurable settings of the Project.

Error

The error object.

Name Type Description
code

ErrorCode

One of a server-defined set of error codes.
details

Error[]

An array of details about specific errors that led to this reported error.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

ErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

ErrorResponse

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

ExtractionFailure

string

InvalidParameterValue

string

InvalidRequest

string

KnowledgeBaseNotFound

string

InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

InnerErrorCode

One of a server-defined set of error codes.
details

object

Error details.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

Error message.
target

string

Error target.

ProjectMetadata

Represents the project.

Name Type Description
createdDateTime

string

Project creation date-time.
description

string

Description of the project.
language

string

Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default.
lastDeployedDateTime

string

Represents the project last deployment date-time.
lastModifiedDateTime

string

Represents the project last modified date-time.
multilingualResource

boolean

Resource enabled for multiple languages across projects or not.
projectName

string

Name of the project.
settings

ProjectSettings

Configurable settings of the Project.

ProjectSettings

Configurable settings of the Project.

Name Type Description
defaultAnswer

string

Default Answer response when no good match is found in the knowledge base.