Conversational Analysis Authoring - Create Project

서비스:

Azure AI Services

API 버전:

2022-05-01

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

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2022-05-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 버전입니다.

요청 헤더

Media Types: "application/merge-patch+json"

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	언어 서비스 리소스에 대한 구독 키입니다.

요청 본문

Media Types: "application/merge-patch+json"

Name	필수	형식	Description
language	True	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
projectKind	True	ProjectKind	프로젝트 종류를 나타냅니다.
projectName	True	string	새 프로젝트 이름입니다.
description		string	프로젝트 설명입니다.
multilingual		boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
settings		ConversationalAnalysisAuthoringProjectSettings	프로젝트 설정입니다.

응답

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

보안

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

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

예제

Successful Create Project

샘플 요청

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01


{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

샘플 응답

상태 코드:

201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

상태 코드:

200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

정의

Name	Description
ConversationalAnalysisAuthoringCreateProjectOptions	프로젝트를 만들거나 업데이트하는 데 사용되는 옵션을 나타냅니다.
ConversationalAnalysisAuthoringProjectMetadata	프로젝트의 메타데이터를 나타냅니다.
ConversationalAnalysisAuthoringProjectSettings	프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	프로젝트 종류를 나타냅니다.

ConversationalAnalysisAuthoringCreateProjectOptions

Object

프로젝트를 만들거나 업데이트하는 데 사용되는 옵션을 나타냅니다.

Name	형식	Description
description	string	프로젝트 설명입니다.
language	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
multilingual	boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
projectKind	ProjectKind	프로젝트 종류를 나타냅니다.
projectName	string	새 프로젝트 이름입니다.
settings	ConversationalAnalysisAuthoringProjectSettings	프로젝트 설정입니다.

ConversationalAnalysisAuthoringProjectMetadata

Object

프로젝트의 메타데이터를 나타냅니다.

Name	형식	Description
createdDateTime	string (date-time)	프로젝트 생성 날짜/시간을 나타냅니다.
description	string	프로젝트 설명입니다.
language	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
lastDeployedDateTime	string (date-time)	마지막으로 배포된 날짜/시간을 프로젝트를 나타냅니다.
lastModifiedDateTime	string (date-time)	프로젝트 생성 날짜/시간을 나타냅니다.
lastTrainedDateTime	string (date-time)	마지막으로 학습된 날짜/시간을 프로젝트를 나타냅니다.
multilingual	boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
projectKind	ProjectKind	프로젝트 종류를 나타냅니다.
projectName	string	새 프로젝트 이름입니다.
settings	ConversationalAnalysisAuthoringProjectSettings	프로젝트 설정입니다.

ConversationalAnalysisAuthoringProjectSettings

Object

프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.

Name	형식	Description
confidenceThreshold	number (float)	예측이 자동으로 "없음"으로 변경되는 신뢰도가 가장 높은 의도의 임계값입니다.

Error

Object

오류 개체입니다.

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

ErrorCode

열거형

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

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

ErrorResponse

Object

오류 응답입니다.

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

InnerErrorCode

열거형

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

값	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

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	오류 대상입니다.

ProjectKind

열거형

프로젝트 종류를 나타냅니다.

값	Description
Conversation	앱, 봇 및 IoT 디바이스에 자연어를 빌드하는 프로젝트입니다.
Orchestration	단일 프로젝트에서 대화, 사용자 지정 질문 답변 및 LUIS 프로젝트를 연결하고 오케스트레이션하는 프로젝트입니다.