Question Answering Projects - Create Project

서비스:

Azure AI Services

API 버전:

2021-10-01

프로젝트를 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string

요청 본문

Name	필수	형식	Description
language	True	string	텍스트 레코드의 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정하지 않으면 영어에 "en"을 기본값으로 사용합니다.
description		string	프로젝트에 대한 설명입니다.
multilingualResource		boolean	동일한 리소스에 대해 다른 언어로 기술 자료를 만들 수 있도록 하려면 true로 설정합니다.
settings		ProjectSettings	Project의 구성 가능한 설정입니다.

응답

Name	형식	Description
200 OK	ProjectMetadata	업데이트된 프로젝트의 메타데이터(이미 있는 경우)입니다.
201 Created	ProjectMetadata	생성된 프로젝트의 메타데이터(없는 경우)입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

예제

Successful query

샘플 요청

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
}

샘플 응답

상태 코드:

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

상태 코드:

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

정의

Name	Description
CreateProjectOptions	프로젝트를 만드는 데 필요한 매개 변수입니다.
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata	프로젝트를 나타냅니다.
ProjectSettings	Project의 구성 가능한 설정입니다.

CreateProjectOptions

Object

프로젝트를 만드는 데 필요한 매개 변수입니다.

Name	형식	Description
description	string	프로젝트에 대한 설명입니다.
language	string	텍스트 레코드의 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정하지 않으면 영어에 "en"을 기본값으로 사용합니다.
multilingualResource	boolean	동일한 리소스에 대해 다른 언어로 기술 자료를 만들 수 있도록 하려면 true로 설정합니다.
settings	ProjectSettings	Project의 구성 가능한 설정입니다.

Error

Object

오류 개체입니다.

Name	형식	Description
code	ErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

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

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

InnerErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

값	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	InnerErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ProjectMetadata

Object

프로젝트를 나타냅니다.

Name	형식	Description
createdDateTime	string (date-time)	프로젝트 생성 날짜-시간.
description	string	프로젝트에 대한 설명입니다.
language	string	텍스트 레코드의 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정하지 않으면 영어에 "en"을 기본값으로 사용합니다.
lastDeployedDateTime	string (date-time)	프로젝트의 마지막 배포 날짜-시간을 나타냅니다.
lastModifiedDateTime	string (date-time)	마지막으로 수정한 날짜-시간을 프로젝트를 나타냅니다.
multilingualResource	boolean	프로젝트 전체에서 여러 언어에 사용할 수 있는 리소스입니다.
projectName	string	프로젝트의 이름입니다.
settings	ProjectSettings	Project의 구성 가능한 설정입니다.

ProjectSettings

Object

Project의 구성 가능한 설정입니다.

Name	형식	Description
defaultAnswer	string	기술 자료에서 일치하는 항목이 없으면 기본 응답 응답입니다.