Analyze Text Submit Job - Analyze Text Submit Job
분석을 위해 텍스트 문서 컬렉션을 제출합니다. 장기 실행 작업으로 실행할 하나 이상의 고유한 작업을 지정합니다.
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
요청 본문
Name | 필수 | 형식 | Description |
---|---|---|---|
analysisInput | True |
분석할 입력을 포함합니다. |
|
tasks | True | AnalyzeTextLROTask[]: |
LRO의 일부로 수행할 작업 목록입니다. |
displayName |
string |
작업의 이름입니다. |
응답
Name | 형식 | Description |
---|---|---|
202 Accepted |
처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더 Operation-Location: string |
|
Other Status Codes |
예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string |
보안
Ocp-Apim-Subscription-Key
형식:
apiKey
In(다음 안에):
header
OAuth2Auth
형식:
oauth2
Flow:
accessCode
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL:
https://login.microsoftonline.com/common/oauth2/token
범위
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
예제
SuccessfulAbstractiveSummarizationSummaryLengthTaskSubmit
샘플 요청
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
{
"displayName": "Document Abstractive Summarization Task Example",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
}
]
},
"tasks": [
{
"kind": "AbstractiveSummarization",
"taskName": "Document Abstractive Summarization Task 1",
"parameters": {
"summaryLength": "medium"
}
}
]
}
샘플 응답
Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01
SuccessfulAbstractiveSummarizationTaskSubmit
샘플 요청
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
{
"displayName": "Document Abstractive Summarization Task Example",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
}
]
},
"tasks": [
{
"kind": "AbstractiveSummarization",
"taskName": "Document Abstractive Summarization Task 1",
"parameters": {
"sentenceCount": 1
}
}
]
}
샘플 응답
Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01
SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest
샘플 요청
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
{
"displayName": "Extracting Location & US Region",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "I had a wonderful trip to Seattle last week."
},
{
"id": "2",
"language": "en",
"text": "I'm flying to NYC tomorrow. See you there."
}
]
},
"tasks": [
{
"kind": "EntityRecognition",
"taskName": "Recognize Entities",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "CustomEntityRecognition",
"taskName": "Recognize US Regions",
"parameters": {
"projectName": "MyProject",
"deploymentName": "MyDeployment"
}
}
]
}
샘플 응답
Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2024-11-01
SuccessfulHealthcareDocumentTypePostRequest
샘플 요청
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
{
"analysisInput": {
"documents": [
{
"text": "Prescribed 100mg ibuprofen, taken twice daily.",
"id": "1",
"language": "en"
}
]
},
"tasks": [
{
"kind": "Healthcare",
"parameters": {
"modelVersion": "latest",
"fhirVersion": "4.0.1",
"documentType": "DischargeSummary"
}
}
]
}
샘플 응답
Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01
SuccessfulHealthcarePostRequest
샘플 요청
POST {Endpoint}/language/analyze-text/jobs?api-version=2024-11-01
{
"analysisInput": {
"documents": [
{
"text": "Prescribed 100mg ibuprofen, taken twice daily.",
"id": "1",
"language": "en"
}
]
},
"tasks": [
{
"kind": "Healthcare",
"parameters": {
"modelVersion": "latest"
}
}
]
}
샘플 응답
Operation-Location: {Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-01
정의
Name | Description |
---|---|
Abstractive |
추상 요약 작업의 작업 정의를 나타내는 개체입니다. |
Abstractive |
미리 작성된 추상화 요약 작업에 대해 지원되는 매개 변수입니다. |
Allow |
겹침 허용 정책을 나타냅니다. 엔터티에 대한 사후 처리 논리를 적용하지 않습니다. 모델이 예측하는 것은 사용자에게 반환되는 항목입니다. 이를 통해 사용자는 모든 단일 모델의 가능한 값을 전체 보기로 볼 수 있으며 엔터티 선택에 고유한 사용자 지정 논리를 적용할 수 있습니다. |
Analyze |
텍스트 LRO 분석의 입력 개체입니다. |
Analyze |
장기 실행 분석 텍스트 작업의 종류가 지원됩니다. |
Custom |
사용자 지정 텍스트 LRO 작업을 포함합니다. |
Custom |
사용자 지정 엔터티 태스크에 대해 지원되는 매개 변수입니다. |
Custom |
사용자 지정 모델을 사용하여 텍스트를 다중 레이블 분류로 분류 |
Custom |
사용자 지정 다중 분류 태스크에 대해 지원되는 매개 변수입니다. |
Custom |
사용자 지정 모델을 사용하여 텍스트를 단일 레이블 분류로 분류 |
Custom |
사용자 지정 단일 분류 태스크에 대해 지원되는 매개 변수입니다. |
Entities |
엔터티 인식 태스크에 대한 작업 정의를 나타내는 개체입니다. |
Entities |
엔터티 인식 태스크에 대해 지원되는 매개 변수입니다. |
Entity |
엔터티 인식에서 검색된 모든 엔터티 범주를 포함합니다. |
Entity |
명명된 엔터티 인식에 허용되는 유추 옵션을 포함하는 클래스입니다. |
Entity |
LRO 작업을 연결하는 엔터티 분석 텍스트를 포함합니다. |
Entity |
엔터티 연결 태스크에 대해 지원되는 매개 변수입니다. |
Error |
서비스가 요청을 처리하는 동안 일부 오류가 발생할 때 반환되는 오류 응답 개체입니다. |
Error |
사람이 읽을 수 있는 오류 코드입니다. |
Error |
오류 응답입니다. |
Extractive |
추출 요약 태스크의 작업 정의를 나타내는 개체입니다. |
Extractive |
추출된 요약을 정렬하는 방법을 지정합니다. |
Extractive |
추출 요약 작업에 대해 지원되는 매개 변수입니다. |
fhir |
FHIR 사양 버전입니다. |
healthcare |
문서 형식입니다. |
Healthcare |
의료 입력 문서에서 서비스에서 수행할 장기 실행 작업입니다. |
Healthcare |
의료 작업에 대해 지원되는 매개 변수입니다. |
Inner |
사람이 읽을 수 있는 오류 코드입니다. |
Inner |
오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Key |
핵심 구 추출 태스크에 대한 작업 정의를 나타내는 개체입니다. |
Key |
핵심 구 추출 작업에 대해 지원되는 매개 변수입니다. |
Match |
가장 긴 일치 겹침 정책을 나타냅니다. 가능한 한 겹치는 엔터티가 없습니다. 1. 겹치는 엔터티가 있는 경우 가장 긴 엔터티가 반환됩니다. 2. 2개 이상의 엔터티에 대해 예측된 문자 집합이 정확히 동일한 경우 신뢰도 점수가 더 높은 엔터티를 선택합니다.3. 엔터티 점수가 동일하면 이전 규칙을 적용한 후에도 여전히 존재하는 모든 엔터티를 반환합니다. 3. Hello Text Analytics와 같이 부분 중복이 있는 경우 1부터 시작하는 위의 단계를 수행합니다. |
Multi |
서비스에서 분석할 입력 문서의 컬렉션입니다. |
Multi |
서비스에서 분석할 입력 문서를 포함합니다. |
Pii |
(선택 사항) 반환할 PII 범주에 대해 설명합니다. |
Pii |
PII 작업용 도메인 |
Pii |
PIIEntityRecognition LRO 작업 분석 텍스트를 포함합니다. |
Pii |
PII 엔터티 인식 태스크에 대해 지원되는 매개 변수입니다. |
Sentiment |
감정 분석 태스크의 작업 정의를 나타내는 개체입니다. |
Sentiment |
감정 분석 태스크에 지원되는 매개 변수입니다. |
String |
문자열 인덱스 형식 |
Summary |
출력 요약의 길이를 정의하는 열거형입니다. |
AbstractiveSummarizationLROTask
추상 요약 작업의 작업 정의를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Abstractive |
수행할 작업의 종류입니다. |
parameters |
추상화 요약 작업에 대한 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
AbstractiveSummarizationTaskParameters
미리 작성된 추상화 요약 작업에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
sentenceCount |
integer |
출력 요약의 대략적인 문장 수를 제어합니다. |
|
stringIndexType | TextElements_v8 |
문자열 인덱스 형식 |
|
summaryLength |
(참고: sentenceCount보다 summaryLength를 사용하는 것이 좋습니다.) 출력 요약의 대략적인 길이를 제어합니다. |
AllowOverlapEntityPolicyType
겹침 허용 정책을 나타냅니다. 엔터티에 대한 사후 처리 논리를 적용하지 않습니다. 모델이 예측하는 것은 사용자에게 반환되는 항목입니다. 이를 통해 사용자는 모든 단일 모델의 가능한 값을 전체 보기로 볼 수 있으며 엔터티 선택에 고유한 사용자 지정 논리를 적용할 수 있습니다.
Name | 형식 | Default value | Description |
---|---|---|---|
policyKind |
string:
allow |
matchLongest |
Entity OverlapPolicy 개체 종류입니다. |
AnalyzeTextJobsInput
텍스트 LRO 분석의 입력 개체입니다.
Name | 형식 | Description |
---|---|---|
analysisInput |
분석할 입력을 포함합니다. |
|
displayName |
string |
작업의 이름입니다. |
tasks | AnalyzeTextLROTask[]: |
LRO의 일부로 수행할 작업 목록입니다. |
AnalyzeTextLROTaskKind
장기 실행 분석 텍스트 작업의 종류가 지원됩니다.
Name | 형식 | Description |
---|---|---|
AbstractiveSummarization |
string |
추상적 요약 작업 |
CustomEntityRecognition |
string |
사용자 지정 엔터티 인식 작업 |
CustomMultiLabelClassification |
string |
사용자 지정 다중 레이블 분류 작업 |
CustomSingleLabelClassification |
string |
사용자 지정 단일 레이블 분류 작업 |
EntityLinking |
string |
엔터티 연결 작업 |
EntityRecognition |
string |
엔터티 인식 작업 |
ExtractiveSummarization |
string |
추출 요약 작업 |
Healthcare |
string |
의료 작업 |
KeyPhraseExtraction |
string |
핵심 구 추출 작업 |
PiiEntityRecognition |
string |
PII 엔터티 인식 작업 |
SentimentAnalysis |
string |
감정 분석 작업 |
CustomEntitiesLROTask
사용자 지정 텍스트 LRO 작업을 포함합니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Custom |
수행할 작업의 종류입니다. |
parameters |
작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
CustomEntitiesTaskParameters
사용자 지정 엔터티 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
deploymentName |
string |
이 필드는 모델의 배포 이름을 나타냅니다. |
|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
projectName |
string |
이 필드는 모델의 프로젝트 이름을 나타냅니다. |
|
stringIndexType | TextElements_v8 |
문자열 오프셋을 해석하는 데 사용되는 문자열 인덱스 형식을 제공하는 선택적 매개 변수입니다. 기본값은 TextElements(Graphemes)입니다. |
CustomMultiLabelClassificationLROTask
사용자 지정 모델을 사용하여 텍스트를 다중 레이블 분류로 분류
Name | 형식 | Description |
---|---|---|
kind |
string:
Custom |
수행할 작업의 종류입니다. |
parameters |
작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
CustomMultiLabelClassificationTaskParameters
사용자 지정 다중 분류 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
deploymentName |
string |
이 필드는 모델의 배포 이름을 나타냅니다. |
|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
projectName |
string |
이 필드는 모델의 프로젝트 이름을 나타냅니다. |
CustomSingleLabelClassificationLROTask
사용자 지정 모델을 사용하여 텍스트를 단일 레이블 분류로 분류
Name | 형식 | Description |
---|---|---|
kind |
string:
Custom |
수행할 작업의 종류입니다. |
parameters |
작업 매개 변수 |
|
taskName |
string |
작업 이름 |
CustomSingleLabelClassificationTaskParameters
사용자 지정 단일 분류 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
deploymentName |
string |
이 필드는 모델의 배포 이름을 나타냅니다. |
|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
projectName |
string |
이 필드는 모델의 프로젝트 이름을 나타냅니다. |
EntitiesLROTask
엔터티 인식 태스크에 대한 작업 정의를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Entity |
수행할 작업의 종류입니다. |
parameters |
작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
EntitiesTaskParameters
엔터티 인식 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
exclusionList |
(선택 사항) excludeList가 포함된 엔터티를 필터링하는 요청 매개 변수입니다. 사용자가 excludeList를 지정하면 해당 목록의 엔터티와 함께 반환되는 예측을 가져올 수 없습니다. exclusionList 전에 inclusionList를 적용합니다. |
||
inclusionList |
(선택 사항) 출력을 이 목록에 포함된 요청된 엔터티 형식으로 제한하는 요청 매개 변수입니다. exclusionList 전에 inclusionList를 적용합니다. |
||
inferenceOptions |
(선택 사항) 사용자가 유추를 실행하기 위한 설정을 제공할 수 있도록 하는 요청 매개 변수입니다. |
||
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
overlapPolicy | BaseEntityOverlapPolicy: |
(선택 사항)는 ner 출력에 적용할 겹침 정책의 형식을 설명합니다. |
|
stringIndexType | TextElements_v8 |
(선택 사항) 문자열 오프셋을 해석하는 데 사용되는 문자열 인덱스 형식을 제공하는 매개 변수입니다. 기본값은 TextElements(Graphemes)입니다. |
EntityCategory
엔터티 인식에서 검색된 모든 엔터티 범주를 포함합니다.
Name | 형식 | Description |
---|---|---|
Address |
string |
위치의 특정 거리 수준 언급 : 주택 / 건물 번호, 거리, 도로, 고속도로, 이름으로 참조 교차로. |
Age |
string |
연령 관련 값입니다. |
Airport |
string |
공항. |
Area |
string |
개체의 영역입니다. |
City |
string |
도시 관련 값입니다. |
ComputingProduct |
string |
컴퓨팅 제품. |
Continent |
string |
대륙 관련 값입니다. |
CountryRegion |
string |
국가 또는 지역 관련 값입니다. |
CulturalEvent |
string |
문화권 이벤트 관련 값입니다. |
Currency |
string |
통화 관련 값입니다. |
Date |
string |
일정 날짜입니다. |
DateRange |
string |
날짜 범위입니다. |
DateTime |
string |
일정 날짜(시간이 있는 날짜)입니다. |
DateTimeRange |
string |
날짜 및 시간 범위입니다. |
Dimension |
string |
측정 차원 |
Duration |
string |
기간입니다. |
string |
전자 메일 주소. |
|
Event |
string |
사회, 스포츠, 비즈니스, 정치, 교육, 자연, 역사, 범죄, 폭력, 법적, 시간이 정한 군사 행사. |
GPE |
string |
도시, 국가/지역, 주. |
Geological |
string |
강, 바다 및 사막과 같은 지리적 및 자연 특징. |
Height |
string |
개체의 높이입니다. |
IP |
string |
네트워크 IP 주소. |
Information |
string |
디지털 정보에 대한 측정 단위입니다. |
Length |
string |
개체의 길이입니다. |
Location |
string |
물리적 공간의 특정 지점 또는 위치입니다. |
NaturalEvent |
string |
자연 이벤트 관련 값입니다. |
Number |
string |
단위가 없는 숫자 |
NumberRange |
string |
숫자 범위 |
Numeric |
string |
숫자 및 숫자 단어를 포함한 숫자 값입니다. |
Ordinal |
string |
서수입니다. |
Organization |
string |
일부 설정된 조직 구조에 의해 정의된 기업, 기관 및 기타 사용자 그룹. 이러한 레이블에는 회사, 정당/운동, 음악 밴드, 스포츠 클럽, 정부 기관 및 공공 조직이 포함될 수 있습니다. 국적이나 종교는 조직이 아닙니다. |
OrganizationMedical |
string |
의료 회사 및 그룹. |
OrganizationSports |
string |
스포츠 관련 조직. |
OrganizationStockExchange |
string |
증권 거래소 그룹. |
Percentage |
string |
백분율 관련 값입니다. |
Person |
string |
첫 번째, 마지막 및 중간 이름, 가상 문자의 이름 및 별칭입니다. 제목(예: 'Mr.' 또는 'President'는 명명된 엔터티의 일부로 간주되지 않습니다. |
PersonType |
string |
그룹 멤버 자격으로 분류된 사용자 역할입니다. |
PhoneNumber |
string |
전화 번호(미국 및 EU 전화 번호만 해당). |
Product |
string |
상용, 소모성 개체, 전자 제품, 차량, 식품 그룹의 단일 또는 그룹. |
SetTemporal |
string |
시간 관련 값의 집합입니다. |
Skill |
string |
기능, 기술 또는 전문 지식. |
Speed |
string |
개체의 속도입니다. |
SportsEvent |
string |
스포츠 이벤트 관련 값입니다. |
State |
string |
상태 관련 값입니다. |
Structural |
string |
인공 구조물. |
Temperature |
string |
온도 관련 값입니다. |
Temporal |
string |
시간과 관련된 항목입니다. |
Time |
string |
하루 중 시간입니다. |
TimeRange |
string |
시간 범위입니다. |
URL |
string |
웹 사이트에 대한 URL입니다. |
Volume |
string |
개체의 볼륨입니다. |
Weight |
string |
개체의 가중치입니다. |
EntityInferenceOptions
명명된 엔터티 인식에 허용되는 유추 옵션을 포함하는 클래스입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
excludeNormalizedValues |
boolean |
False |
정규화되고 메타데이터에 포함할 검색된 엔터티 값을 포함/제외하는 옵션입니다. 숫자 및 임시 엔터티 형식은 값 정규화를 지원합니다. |
EntityLinkingLROTask
LRO 작업을 연결하는 엔터티 분석 텍스트를 포함합니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Entity |
수행할 작업의 종류입니다. |
parameters |
작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
EntityLinkingTaskParameters
엔터티 연결 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
stringIndexType | TextElements_v8 |
문자열 오프셋을 해석하는 데 사용되는 문자열 인덱스 형식을 제공하는 선택적 매개 변수입니다. 기본값은 TextElements(Graphemes)입니다. |
Error
서비스가 요청을 처리하는 동안 일부 오류가 발생할 때 반환되는 오류 응답 개체입니다.
Name | 형식 | Description |
---|---|---|
code |
서버에서 정의한 오류 코드 집합 중 하나입니다. |
|
details |
Error[] |
이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
target |
string |
오류의 대상입니다. |
ErrorCode
사람이 읽을 수 있는 오류 코드입니다.
Name | 형식 | Description |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
Azure Cognitive Search 인덱스 제한에 도달한 오류 |
AzureCognitiveSearchIndexNotFound |
string |
Azure Cognitive Search 인덱스 찾을 수 없음 오류 |
AzureCognitiveSearchNotFound |
string |
Azure Cognitive Search를 찾을 수 없음 오류 |
AzureCognitiveSearchThrottling |
string |
Azure Cognitive Search 제한 오류 |
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 |
오류 개체입니다. |
ExtractiveSummarizationLROTask
추출 요약 태스크의 작업 정의를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Extractive |
수행할 작업의 종류입니다. |
parameters |
추출 요약 작업에 대한 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
ExtractiveSummarizationSortingCriteria
추출된 요약을 정렬하는 방법을 지정합니다.
Name | 형식 | Description |
---|---|---|
Offset |
string |
결과가 텍스트의 모양 순서대로 정렬되어야 했음을 나타냅니다. |
Rank |
string |
결과에 따라 중요도(즉, 순위 점수) 순서로 결과를 정렬해야 임을 나타냅니다. |
ExtractiveSummarizationTaskParameters
추출 요약 작업에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
sentenceCount |
integer |
3 |
추출된 요약의 문장 수를 지정합니다. |
sortBy | Offset |
추출된 요약을 정렬하는 방법을 지정합니다. |
|
stringIndexType | TextElements_v8 |
문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. |
fhirVersion
FHIR 사양 버전입니다.
Name | 형식 | Description |
---|---|---|
4.0.1 |
string |
버전 4.0.1 |
healthcareDocumentType
문서 형식입니다.
Name | 형식 | Description |
---|---|---|
ClinicalTrial |
string |
임상 시험 문서 유형 |
Consult |
string |
문서 유형 참조 |
DischargeSummary |
string |
출력 요약 문서 유형 |
HistoryAndPhysical |
string |
기록 및 실제 문서 유형 |
Imaging |
string |
이미징 문서 유형 |
None |
string |
없음 문서 형식 |
Pathology |
string |
병리학 문서 형식 |
ProcedureNote |
string |
프로시저 메모 문서 형식 |
ProgressNote |
string |
진행률 메모 문서 유형 |
HealthcareLROTask
의료 입력 문서에서 서비스에서 수행할 장기 실행 작업입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Healthcare |
수행할 작업의 종류입니다. |
parameters |
의료 작업에 대한 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
HealthcareTaskParameters
의료 작업에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
documentType |
Fhir 문서에 대한 입력으로 제공할 수 있는 문서 형식입니다. 사용할 때 fhirVersion이 제공되어야 합니다. None 열거형을 사용하는 동작은 documentType 매개 변수를 사용하지 않는 것과 같습니다. |
||
fhirVersion |
결과에서 fhirBundle의 형식을 지정하는 데 사용할 FHIR 사양 버전입니다. 자세한 내용은 https://www.hl7.org/fhir/overview.html참조하세요. |
||
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
stringIndexType | TextElements_v8 |
문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. |
InnerErrorCode
사람이 읽을 수 있는 오류 코드입니다.
Name | 형식 | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
Azure Cognitive Search를 찾을 수 없음 오류 |
AzureCognitiveSearchThrottling |
string |
Azure Cognitive Search 제한 오류 |
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 |
서버에서 정의한 오류 코드 집합 중 하나입니다. |
|
details |
object |
오류 세부 정보입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
KeyPhraseLROTask
핵심 구 추출 태스크에 대한 작업 정의를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Key |
수행할 작업의 종류입니다. |
parameters |
핵심 구 추출 작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
KeyPhraseTaskParameters
핵심 구 추출 작업에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
MatchLongestEntityPolicyType
가장 긴 일치 겹침 정책을 나타냅니다. 가능한 한 겹치는 엔터티가 없습니다. 1. 겹치는 엔터티가 있는 경우 가장 긴 엔터티가 반환됩니다. 2. 2개 이상의 엔터티에 대해 예측된 문자 집합이 정확히 동일한 경우 신뢰도 점수가 더 높은 엔터티를 선택합니다.3. 엔터티 점수가 동일하면 이전 규칙을 적용한 후에도 여전히 존재하는 모든 엔터티를 반환합니다. 3. Hello Text Analytics와 같이 부분 중복이 있는 경우 1부터 시작하는 위의 단계를 수행합니다.
Name | 형식 | Default value | Description |
---|---|---|---|
policyKind |
string:
match |
matchLongest |
Entity OverlapPolicy 개체 종류입니다. |
MultiLanguageAnalysisInput
서비스에서 분석할 입력 문서의 컬렉션입니다.
Name | 형식 | Description |
---|---|---|
documents |
분석할 입력 문서입니다. |
MultiLanguageInput
서비스에서 분석할 입력 문서를 포함합니다.
Name | 형식 | Description |
---|---|---|
id |
string |
비어있지 않은 고유한 문서 식별자입니다. |
language |
string |
(선택 사항) 이는 언어의 2자 ISO 639-1 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정하지 않으면 영어에 "en"을 기본값으로 사용합니다. (다음은 2023-04-15-preview 이상에만 적용됨) 자동 언어 검색의 경우 "auto"를 사용합니다. 설정하지 않으면 영어에 "en"을 기본값으로 사용합니다. |
text |
string |
처리할 입력 텍스트입니다. |
PiiCategory
(선택 사항) 반환할 PII 범주에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
ABARoutingNumber |
string |
ABA 라우팅 번호 |
ARNationalIdentityNumber |
string |
AR 국가 ID 번호 |
ATIdentityCard |
string |
AT ID 카드 |
ATTaxIdentificationNumber |
string |
AT 세금 식별 번호 |
ATValueAddedTaxNumber |
string |
AT 부가가치세 번호 |
AUBankAccountNumber |
string |
AT ID 카드 |
AUBusinessNumber |
string |
AU 비즈니스 번호 |
AUCompanyNumber |
string |
AU 회사 번호 |
AUDriversLicenseNumber |
string |
AU 운전 면허증 번호 |
AUMedicalAccountNumber |
string |
AU 의료 계정 번호 |
AUPassportNumber |
string |
AU Passport 번호 |
AUTaxFileNumber |
string |
AU 세금 파일 번호 |
Address |
string |
주소 |
Age |
string |
연령 |
All |
string |
모든 PII 범주입니다. |
AzureDocumentDBAuthKey |
string |
Azure Document DB 인증 키 |
AzureIAASDatabaseConnectionAndSQLString |
string |
Azure IAAS 데이터베이스 연결 및 SQL 문자열 |
AzureIoTConnectionString |
string |
Azure IoT 연결 문자열 |
AzurePublishSettingPassword |
string |
Azure 게시 설정 암호 |
AzureRedisCacheString |
string |
Azure Redis Cache 문자열 |
AzureSAS |
string |
Azure SAS |
AzureServiceBusString |
string |
Azure Service Bus 문자열 |
AzureStorageAccountGeneric |
string |
Azure Storage 계정 일반 |
AzureStorageAccountKey |
string |
Azure Storage 계정 키 |
BENationalNumber |
string |
BE National Number |
BENationalNumberV2 |
string |
BE National Number V2 |
BEValueAddedTaxNumber |
string |
BE 부가가치세 번호 |
BGUniformCivilNumber |
string |
BG Uniform Civil Number |
BRCPFNumber |
string |
BR CPF 번호 |
BRLegalEntityNumber |
string |
BR 법인 번호 |
BRNationalIDRG |
string |
BR National ID RG |
CABankAccountNumber |
string |
CA 은행 계좌 번호 |
CADriversLicenseNumber |
string |
CA 운전 면허증 번호 |
CAHealthServiceNumber |
string |
CA Health Service 번호 |
CAPassportNumber |
string |
CA Passport 번호 |
CAPersonalHealthIdentification |
string |
CA 개인 건강 식별 |
CASocialInsuranceNumber |
string |
CA 사회 보험 번호 |
CHSocialSecurityNumber |
string |
CH 주민등록번호 |
CLIdentityCardNumber |
string |
CL ID 카드 번호 |
CNResidentIdentityCardNumber |
string |
CN 주민 ID 카드 번호 |
CYIdentityCard |
string |
CY ID 카드 |
CYTaxIdentificationNumber |
string |
CY 세금 식별 번호 |
CZPersonalIdentityNumber |
string |
CZ 개인 ID 번호 |
CZPersonalIdentityV2 |
string |
CZ 개인 ID V2 |
CreditCardNumber |
string |
신용 카드 번호 |
DEDriversLicenseNumber |
string |
DE 운전 면허증 번호 |
DEIdentityCardNumber |
string |
DE ID 카드 번호 |
DEPassportNumber |
string |
DE Passport 번호 |
DETaxIdentificationNumber |
string |
DE 세금 식별 번호 |
DEValueAddedNumber |
string |
DE 부가가치 번호 |
DKPersonalIdentificationNumber |
string |
DK 개인 식별 번호 |
DKPersonalIdentificationV2 |
string |
DK 개인 식별 V2 |
Date |
string |
날짜 |
Default |
string |
언어의 기본 PII 범주입니다. |
DrugEnforcementAgencyNumber |
string |
마약 단속 기관 번호 |
EEPersonalIdentificationCode |
string |
EE 개인 식별 코드 |
ESDNI |
string |
ES DNI |
ESSocialSecurityNumber |
string |
ES 주민등록번호 |
ESTaxIdentificationNumber |
string |
ES 세금 식별 번호 |
EUDebitCardNumber |
string |
EU 직불 카드 번호 |
EUDriversLicenseNumber |
string |
EU 운전 면허증 번호 |
EUGPSCoordinates |
string |
EU GPS 좌표 |
EUNationalIdentificationNumber |
string |
EU 국가 식별 번호 |
EUPassportNumber |
string |
EU 여권 번호 |
EUSocialSecurityNumber |
string |
EU 사회 보장 번호 |
EUTaxIdentificationNumber |
string |
EU 세금 식별 번호 |
string |
메일 주소 |
|
FIEuropeanHealthNumber |
string |
FI 유럽 건강 번호 |
FINationalID |
string |
FI 국가 ID |
FINationalIDV2 |
string |
FI 국가 ID V2 |
FIPassportNumber |
string |
FI 여권 번호 |
FRDriversLicenseNumber |
string |
FR 운전 면허증 번호 |
FRHealthInsuranceNumber |
string |
FR 건강 보험 번호 |
FRNationalID |
string |
FR 국가 ID |
FRPassportNumber |
string |
FR Passport 번호 |
FRSocialSecurityNumber |
string |
FR 주민등록번호 |
FRTaxIdentificationNumber |
string |
FR 세금 식별 번호 |
FRValueAddedTaxNumber |
string |
FR 부가가치세 번호 |
GRNationalIDCard |
string |
GR 국가 ID 카드 |
GRNationalIDV2 |
string |
GR National ID V2 |
GRTaxIdentificationNumber |
string |
GR 세금 식별 번호 |
HKIdentityCardNumber |
string |
HK ID 카드 번호 |
HRIdentityCardNumber |
string |
HR ID 카드 번호 |
HRNationalIDNumber |
string |
HR 국가 ID 번호 |
HRPersonalIdentificationNumber |
string |
HR 개인 식별 번호 |
HRPersonalIdentificationOIBNumberV2 |
string |
HR 개인 식별 OIB 번호 V2 |
HUPersonalIdentificationNumber |
string |
HU 개인 식별 번호 |
HUTaxIdentificationNumber |
string |
HU 세금 식별 번호 |
HUValueAddedNumber |
string |
HU 부가가치 번호 |
IDIdentityCardNumber |
string |
ID ID 카드 번호 |
IEPersonalPublicServiceNumber |
string |
IE 개인 공용 서비스 번호 |
IEPersonalPublicServiceNumberV2 |
string |
IE 개인 공용 서비스 번호 V2 |
ILBankAccountNumber |
string |
IL 은행 계좌 번호 |
ILNationalID |
string |
IL 국가 ID |
INPermanentAccount |
string |
IN 영구 계정 |
INUniqueIdentificationNumber |
string |
IN 고유 ID 번호 |
IPAddress |
string |
IP 주소 |
ITDriversLicenseNumber |
string |
IT 운전 면허증 번호 |
ITFiscalCode |
string |
IT 회계 코드 |
ITValueAddedTaxNumber |
string |
IT 부가가치세 번호 |
InternationalBankingAccountNumber |
string |
국제 은행 계좌 번호 |
JPBankAccountNumber |
string |
JP 은행 계좌 번호 |
JPDriversLicenseNumber |
string |
JP 운전 면허증 번호 |
JPMyNumberCorporate |
string |
JP 내 번호 회사 |
JPMyNumberPersonal |
string |
JP 내 번호 개인 |
JPPassportNumber |
string |
JP Passport 번호 |
JPResidenceCardNumber |
string |
JP 레지던스 카드 번호 |
JPResidentRegistrationNumber |
string |
JP 주민등록번호 |
JPSocialInsuranceNumber |
string |
JP 사회 보험 번호 |
KRResidentRegistrationNumber |
string |
KR 주민등록번호 |
LTPersonalCode |
string |
LT 개인 코드 |
LUNationalIdentificationNumberNatural |
string |
LU 국가 식별 번호 자연 |
LUNationalIdentificationNumberNonNatural |
string |
LU 국가 식별 번호 비 자연 |
LVPersonalCode |
string |
LV 개인 코드 |
MTIdentityCardNumber |
string |
MT ID 카드 번호 |
MTTaxIDNumber |
string |
MT 세금 ID 번호 |
MYIdentityCardNumber |
string |
내 ID 카드 번호 |
NLCitizensServiceNumber |
string |
NL 시민 서비스 번호 |
NLCitizensServiceNumberV2 |
string |
NL 시민 서비스 번호 V2 |
NLTaxIdentificationNumber |
string |
NL 세금 식별 번호 |
NLValueAddedTaxNumber |
string |
NL 부가가치세 번호 |
NOIdentityNumber |
string |
ID 번호 없음 |
NZBankAccountNumber |
string |
NZ 은행 계좌 번호 |
NZDriversLicenseNumber |
string |
NZ 운전 면허증 번호 |
NZInlandRevenueNumber |
string |
NZ 내륙 수익 번호 |
NZMinistryOfHealthNumber |
string |
NZ 보건부 번호 |
NZSocialWelfareNumber |
string |
NZ 사회복지 번호 |
Organization |
string |
조직 |
PHUnifiedMultiPurposeIDNumber |
string |
PH 통합 다목적 ID 번호 |
PLIdentityCard |
string |
PL ID 카드 |
PLNationalID |
string |
PL 국가 ID |
PLNationalIDV2 |
string |
PL National ID V2 |
PLPassportNumber |
string |
PL 여권 번호 |
PLREGONNumber |
string |
PL REGON 번호 |
PLTaxIdentificationNumber |
string |
PL 세금 식별 번호 |
PTCitizenCardNumber |
string |
PT 시민 카드 번호 |
PTCitizenCardNumberV2 |
string |
PT 시민 카드 번호 V2 |
PTTaxIdentificationNumber |
string |
PT 세금 식별 번호 |
Person |
string |
사람 |
PhoneNumber |
string |
전화번호 |
ROPersonalNumericalCode |
string |
RO 개인 숫자 코드 |
RUPassportNumberDomestic |
string |
RU Passport 번호 국내 |
RUPassportNumberInternational |
string |
RU Passport Number International |
SANationalID |
string |
SA 국가 ID |
SENationalID |
string |
SE 국가 ID |
SENationalIDV2 |
string |
SE National ID V2 |
SEPassportNumber |
string |
SE Passport 번호 |
SETaxIdentificationNumber |
string |
SE 세금 식별 번호 |
SGNationalRegistrationIdentityCardNumber |
string |
SG 국가 등록 ID 카드 번호 |
SITaxIdentificationNumber |
string |
SI 세금 식별 번호 |
SIUniqueMasterCitizenNumber |
string |
SI 고유 마스터 시민 번호 |
SKPersonalNumber |
string |
SK 개인 번호 |
SQLServerConnectionString |
string |
SQL Server 연결 문자열 |
SWIFTCode |
string |
SWIFT 코드 |
THPopulationIdentificationCode |
string |
TH 인구 식별 코드 |
TRNationalIdentificationNumber |
string |
TR 국가 식별 번호 |
TWNationalID |
string |
TW 국가 ID |
TWPassportNumber |
string |
TW 여권 번호 |
TWResidentCertificate |
string |
TW 상주 인증서 |
UAPassportNumberDomestic |
string |
UA 여권 번호 국내 |
UAPassportNumberInternational |
string |
UA Passport Number International |
UKDriversLicenseNumber |
string |
영국 운전 면허증 번호 |
UKElectoralRollNumber |
string |
영국 선거 롤 번호 |
UKNationalHealthNumber |
string |
영국 국민 건강 번호 |
UKNationalInsuranceNumber |
string |
영국 국민 보험 번호 |
UKUniqueTaxpayerNumber |
string |
영국 고유 납세자 번호 |
URL |
string |
URL |
USBankAccountNumber |
string |
미국 은행 계좌 번호 |
USDriversLicenseNumber |
string |
미국 운전 면허증 번호 |
USIndividualTaxpayerIdentification |
string |
미국 개인 납세자 식별 |
USSocialSecurityNumber |
string |
미국 사회 보장 번호 |
USUKPassportNumber |
string |
미국 영국 여권 번호 |
ZAIdentificationNumber |
string |
ZA ID 번호 |
PiiDomain
PII 작업용 도메인
Name | 형식 | Description |
---|---|---|
none |
string |
도메인이 지정되지 않음을 나타냅니다. |
phi |
string |
개인 건강 정보 도메인의 엔터티를 수정해야 임을 나타냅니다. |
PiiLROTask
PIIEntityRecognition LRO 작업 분석 텍스트를 포함합니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Pii |
수행할 작업의 종류입니다. |
parameters |
Pii 작업 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
PiiTaskParameters
PII 엔터티 인식 태스크에 대해 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
domain | none |
PII 작업용 도메인 |
|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
piiCategories |
응답에 반환될 PII 범주의 열거형입니다. |
||
stringIndexType | TextElements_v8 |
분석에 사용할 StringIndexType입니다. |
SentimentAnalysisLROTask
감정 분석 태스크의 작업 정의를 나타내는 개체입니다.
Name | 형식 | Description |
---|---|---|
kind |
string:
Sentiment |
수행할 작업의 종류입니다. |
parameters |
감정 분석 태스크에 대한 매개 변수입니다. |
|
taskName |
string |
작업 이름 |
SentimentAnalysisTaskParameters
감정 분석 태스크에 지원되는 매개 변수입니다.
Name | 형식 | Default value | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
로깅 옵트아웃 |
modelVersion |
string |
latest |
모델 버전 |
opinionMining |
boolean |
False |
요청에 오피니언 마이닝을 사용할지 여부입니다. |
stringIndexType | TextElements_v8 |
문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. |
StringIndexType
문자열 인덱스 형식
Name | 형식 | Description |
---|---|---|
TextElements_v8 |
string |
반환된 오프셋 및 길이 값은 유니코드 8.0.0 표준을 확인하는 TextElements(Graphemes 및 Grapheme 클러스터)에 해당합니다. 애플리케이션이 .Net Framework 또는 .Net Core로 작성되었으며 StringInfo를 사용하는 경우 이 옵션을 사용합니다. |
UnicodeCodePoint |
string |
반환된 오프셋 및 길이 값은 유니코드 코드 포인트에 해당합니다. 애플리케이션이 유니코드를 지원하는 언어(예: Python)로 작성된 경우 이 옵션을 사용합니다. |
Utf16CodeUnit |
string |
반환된 오프셋 및 길이 값은 UTF-16 코드 단위에 해당합니다. 애플리케이션이 유니코드를 지원하는 언어(예: Java, JavaScript)로 작성된 경우 이 옵션을 사용합니다. |
SummaryLengthBucket
출력 요약의 길이를 정의하는 열거형입니다.
Name | 형식 | Description |
---|---|---|
long |
string |
모델에 긴 길이 요약을 생성하도록 지시합니다. |
medium |
string |
모델에서 중간 길이 요약을 생성하도록 지시합니다. |
short |
string |
모델에서 더 짧은 길이 요약을 생성하도록 지시합니다. |