Conversational Analysis Authoring - Import

서비스:

Azure AI Services

API 버전:

2022-05-01

프로젝트를 가져오는 작업을 트리거합니다. 이름이 같은 프로젝트가 이미 있는 경우 해당 프로젝트의 데이터가 바뀝니다.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2022-05-01

선택적 매개 변수:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01

URI 매개 변수

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

요청 헤더

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

요청 본문

Name	필수	형식	Description
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	프로젝트 메타데이터를 나타냅니다.
projectFileVersion	True	string	내보낸 파일의 버전입니다.
stringIndexType	True	StringIndexType	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	프로젝트 자산을 나타냅니다.

응답

Name	형식	Description
202 Accepted		작업의 상태를 확인하는 데 사용되는 Operation-Location 헤더가 포함된 성공적인 호출 결과. 헤더 operation-location: string
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

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

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

예제

Successful Import Project

샘플 요청

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-01


{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "EmailApp",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "en-us"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "Read"
      },
      {
        "category": "Delete"
      }
    ],
    "entities": [
      {
        "category": "Sender"
      }
    ],
    "utterances": [
      {
        "text": "Open Blake's email",
        "dataset": "Train",
        "intent": "Read",
        "entities": [
          {
            "category": "Sender",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "Delete last email",
        "language": "en-gb",
        "dataset": "Test",
        "intent": "Delete",
        "entities": []
      }
    ]
  }
}

샘플 응답

상태 코드:

202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

정의

Name	Description
CompositionSetting	엔터티의 구성 요소가 서로 겹칠 때 따라야 하는 동작입니다.
ConversationalAnalysisAuthoringConversationExportedEntity	구성 요소가 있는 엔터티를 나타냅니다.
ConversationalAnalysisAuthoringConversationExportedIntent	대화형 프로젝트의 내보낸 의도를 나타냅니다.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	대화형 프로젝트의 내보낸 자산을 나타냅니다.
ConversationalAnalysisAuthoringConversationExportedUtterance	대화형 프로젝트에 대해 내보낸 발언을 나타냅니다.
ConversationalAnalysisAuthoringCreateProjectOptions	프로젝트를 만들거나 업데이트하는 데 사용되는 옵션을 나타냅니다.
ConversationalAnalysisAuthoringExportedConversationOrchestration	대화형 프로젝트 대상에 대한 오케스트레이션 세부 정보를 정의합니다.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	대화형 프로젝트 대상에 대한 오케스트레이션 옵션을 나타냅니다.
ConversationalAnalysisAuthoringExportedEntityList	엔터티의 목록 구성 요소를 나타냅니다.
ConversationalAnalysisAuthoringExportedEntityListSynonym	목록 구성 요소 내의 동의어 목록을 나타냅니다.
ConversationalAnalysisAuthoringExportedEntitySublist	목록 구성 요소 내의 하위 목록을 나타냅니다.
ConversationalAnalysisAuthoringExportedLuisOrchestration	LUIS 애플리케이션 대상에 대한 오케스트레이션 세부 정보를 정의합니다.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	LUIS 애플리케이션 대상에 대한 오케스트레이션 옵션을 나타냅니다.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	내보낸 미리 빌드된 엔터티 구성 요소를 나타냅니다.
ConversationalAnalysisAuthoringExportedProject	내보낸 프로젝트를 나타냅니다.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	질문 답변 프로젝트 대상에 대한 오케스트레이션 세부 정보를 정의합니다.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	질문 답변 프로젝트 대상에 대한 오케스트레이션 옵션을 나타냅니다.
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	발화에 대한 엔터티 레이블을 나타냅니다.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	오케스트레이션 프로젝트에 대해 내보낸 의도를 나타냅니다.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	오케스트레이션 프로젝트의 자산을 나타냅니다.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	오케스트레이션 프로젝트의 발언을 나타냅니다.
ConversationalAnalysisAuthoringProjectSettings	프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.
Error	Error 개체.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
ExportedProjectFormat	사용할 내보낸 프로젝트 파일의 형식입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	프로젝트 종류를 나타냅니다.
StringIndexType	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.

CompositionSetting

엔터티의 구성 요소가 서로 겹칠 때 따라야 하는 동작입니다.

Name	형식	Description
combineComponents	string	텍스트에서 두 개 이상의 구성 요소가 발견되고 겹치면 구성 요소의 범위가 모두 결합된 하나의 범위로 병합됩니다.
requireExactOverlap	string	모든 구성 요소가 반환할 엔터티에 대해 텍스트의 정확히 동일한 문자에서 겹쳐야 합니다. 정의된 구성 요소 중 하나가 일치하지 않거나 예측되지 않으면 엔터티가 반환되지 않습니다.
returnLongestOverlap	string	텍스트에서 두 개 이상의 구성 요소가 발견되고 겹치면 가장 긴 문자 집합이 있는 구성 요소가 반환됩니다.
separateComponents	string	모든 구성 요소의 일치 또는 예측은 엔터티의 개별 인스턴스로 반환됩니다.

ConversationalAnalysisAuthoringConversationExportedEntity

구성 요소가 있는 엔터티를 나타냅니다.

Name	형식	Description
category	string	엔터티의 범주입니다.
compositionSetting	CompositionSetting	엔터티의 구성 요소가 서로 겹칠 때 따라야 하는 동작입니다.
list	ConversationalAnalysisAuthoringExportedEntityList	엔터티의 목록 구성 요소입니다.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	미리 빌드된 엔터티 구성 요소입니다.

ConversationalAnalysisAuthoringConversationExportedIntent

대화형 프로젝트의 내보낸 의도를 나타냅니다.

Name	형식	Description
category	string	의도 범주입니다.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

대화형 프로젝트의 내보낸 자산을 나타냅니다.

Name	형식	Description
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	프로젝트에 정의된 엔터티입니다.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	프로젝트에 정의된 의도입니다.
projectKind	string: Conversation	자산을 포함하는 프로젝트의 형식입니다.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	프로젝트에 정의된 발화입니다.

ConversationalAnalysisAuthoringConversationExportedUtterance

대화형 프로젝트에 대해 내보낸 발언을 나타냅니다.

Name	형식	Description
dataset	string	이 발화의 데이터 세트입니다. 허용되는 값은 '학습' 및 '테스트'입니다.
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	발화의 엔터티 레이블을 나타냅니다.
intent	string	발화의 의도입니다.
language	string	발화의 언어를 나타냅니다. 이는 BCP-47 언어 표현입니다. 예를 들어 영어의 경우 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
text	string	발화 텍스트입니다.

ConversationalAnalysisAuthoringCreateProjectOptions

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

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

ConversationalAnalysisAuthoringExportedConversationOrchestration

대화형 프로젝트 대상에 대한 오케스트레이션 세부 정보를 정의합니다.

Name	형식	Description
deploymentName	string	대상 배포의 이름입니다.
projectName	string	대상 프로젝트의 이름입니다.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

대화형 프로젝트 대상에 대한 오케스트레이션 옵션을 나타냅니다.

Name	형식	Description
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	대화형 프로젝트 대상 세부 정보입니다.
targetProjectKind	string: Conversation	오케스트레이션 흐름에 사용되는 대상의 종류입니다.

ConversationalAnalysisAuthoringExportedEntityList

엔터티의 목록 구성 요소를 나타냅니다.

Name	형식	Description
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	목록 구성 요소의 하위 목록입니다.

ConversationalAnalysisAuthoringExportedEntityListSynonym

목록 구성 요소 내의 동의어 목록을 나타냅니다.

Name	형식	Description
language	string	동의어의 언어를 나타냅니다. 이는 BCP-47 언어 표현입니다. 예를 들어 영어의 경우 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
values	string[]	동의어 목록입니다.

ConversationalAnalysisAuthoringExportedEntitySublist

목록 구성 요소 내의 하위 목록을 나타냅니다.

Name	형식	Description
listKey	string	하위 목록의 키입니다.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	하위 목록에 해당하는 의 구입니다.

ConversationalAnalysisAuthoringExportedLuisOrchestration

LUIS 애플리케이션 대상에 대한 오케스트레이션 세부 정보를 정의합니다.

Name	형식	Description
appId	string	LUIS 애플리케이션 ID입니다.
appVersion	string	대상 버전 ID입니다.
slotName	string	대상 슬롯 이름입니다.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

LUIS 애플리케이션 대상에 대한 오케스트레이션 옵션을 나타냅니다.

Name	형식	Description
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	LUIS 애플리케이션 대상 세부 정보입니다.
targetProjectKind	string: Luis	오케스트레이션 흐름에 사용되는 대상의 종류입니다.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

내보낸 미리 빌드된 엔터티 구성 요소를 나타냅니다.

Name	형식	Description
category	string	미리 빌드된 엔터티 범주입니다.

ConversationalAnalysisAuthoringExportedProject

내보낸 프로젝트를 나타냅니다.

Name	형식	Description
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	프로젝트 자산을 나타냅니다.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	프로젝트 메타데이터를 나타냅니다.
projectFileVersion	string	내보낸 파일의 버전입니다.
stringIndexType	StringIndexType	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

질문 답변 프로젝트 대상에 대한 오케스트레이션 세부 정보를 정의합니다.

Name	형식	Description
projectName	string	대상 프로젝트의 이름입니다.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

질문 답변 프로젝트 대상에 대한 오케스트레이션 옵션을 나타냅니다.

Name	형식	Description
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	질문 답변 프로젝트 세부 정보입니다.
targetProjectKind	string: QuestionAnswering	오케스트레이션 흐름에 사용되는 대상의 종류입니다.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

발화에 대한 엔터티 레이블을 나타냅니다.

Name	형식	Description
category	string	엔터티 레이블의 범주입니다.
length	integer	엔터티 텍스트의 길이입니다.
offset	integer	엔터티 텍스트의 시작 위치입니다.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

오케스트레이션 프로젝트에 대해 내보낸 의도를 나타냅니다.

Name	형식	Description
category	string	의도 범주입니다.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	오케스트레이션 흐름에서 이 의도의 동작을 지정합니다.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

오케스트레이션 프로젝트의 자산을 나타냅니다.

Name	형식	Description
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	프로젝트의 의도를 나타냅니다.
projectKind	string: Orchestration	자산을 포함하는 프로젝트의 형식입니다.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	프로젝트의 발화를 나타냅니다.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

오케스트레이션 프로젝트의 발언을 나타냅니다.

Name	형식	Description
dataset	string	이 발화의 데이터 세트입니다. 허용되는 값은 '학습' 및 '테스트'입니다.
intent	string	발화의 의도입니다.
language	string	발화의 언어를 나타냅니다. 이는 BCP-47 언어 표현입니다. 예를 들어 영어의 경우 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
text	string	발화 텍스트입니다.

ConversationalAnalysisAuthoringProjectSettings

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

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

Error

Error 개체.

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

ErrorCode

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

Name	형식	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

오류 응답입니다.

Name	형식	Description
error	Error	Error 개체.

ExportedProjectFormat

사용할 내보낸 프로젝트 파일의 형식입니다.

Name	형식	Description
Conversation	string	대화형 프로젝트의 형식을 지정합니다.
Luis	string	LUIS에서 내보낸 애플리케이션의 형식을 지정합니다.

InnerErrorCode

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

Name	형식	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. 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

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

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

StringIndexType

문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.

Name	형식	Description
Utf16CodeUnit	string	오프셋 및 길이 값은 UTF-16 코드 단위에 해당합니다. 애플리케이션이 유니코드를 지원하는 언어(예: Java, JavaScript)로 작성된 경우 이 옵션을 사용합니다.