Text Analysis Runtime - Analyze Text

참조

Service:: Cognitive Services - Language

API Version:: 2023-04-01

문서 컬렉션에 대한 텍스트 분석을 요청합니다.

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
showStats	query		boolean	(선택 사항) true로 설정하면 응답에 요청 및 문서 수준 통계가 포함됩니다.

요청 헤더

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

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

Name	Description
AnalyzeTextEntityLinkingInput	엔터티 연결 입력 분석 텍스트를 포함합니다.
AnalyzeTextEntityRecognitionInput	엔터티 인식은 텍스트 입력 작업 요청을 분석합니다.
AnalyzeTextKeyPhraseExtractionInput	분석 텍스트 KeyPhraseExtraction 작업 입력을 포함합니다.
AnalyzeTextLanguageDetectionInput	언어 감지 문서 분석 작업 입력을 포함합니다.
AnalyzeTextPiiEntitiesRecognitionInput	PIIEntityRecognition 작업 입력 분석 텍스트를 포함합니다.
AnalyzeTextSentimentAnalysisInput	SentimentAnalysis 작업 입력 분석 텍스트를 포함합니다.

AnalyzeTextEntityLinkingInput

엔터티 연결 입력 분석 텍스트를 포함합니다.

Name	필수	형식	Description
kind	True	string: EntityLinking	수행할 작업의 종류입니다.
analysisInput		MultiLanguageAnalysisInput	서비스에서 처리할 분석 입력을 포함합니다.
parameters		EntityLinkingTaskParameters	작업 매개 변수.

AnalyzeTextEntityRecognitionInput

엔터티 인식은 텍스트 입력 작업 요청을 분석합니다.

Name	필수	형식	Description
kind	True	string: EntityRecognition	수행할 작업의 종류입니다.
analysisInput		MultiLanguageAnalysisInput	분석할 입력입니다.
parameters		EntitiesTaskParameters	작업 매개 변수.

AnalyzeTextKeyPhraseExtractionInput

분석 텍스트 KeyPhraseExtraction 작업 입력을 포함합니다.

Name	필수	형식	Description
kind	True	string: KeyPhraseExtraction	수행할 작업의 종류입니다.
analysisInput		MultiLanguageAnalysisInput	입력 문서를 포함합니다.
parameters		KeyPhraseTaskParameters	핵심 구 추출 작업 매개 변수입니다.

AnalyzeTextLanguageDetectionInput

언어 감지 문서 분석 작업 입력을 포함합니다.

Name	필수	형식	Description
kind	True	string: LanguageDetection	수행할 작업의 종류입니다.
analysisInput		LanguageDetectionAnalysisInput	분석할 문서입니다.
parameters		LanguageDetectionTaskParameters	작업 매개 변수입니다.

AnalyzeTextPiiEntitiesRecognitionInput

PIIEntityRecognition 작업 입력 분석 텍스트를 포함합니다.

Name	필수	형식	Description
kind	True	string: PiiEntityRecognition	수행할 작업의 종류입니다.
analysisInput		MultiLanguageAnalysisInput	입력 문서를 포함합니다.
parameters		PiiTaskParameters	Pii 작업 매개 변수입니다.

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis 작업 입력 분석 텍스트를 포함합니다.

Name	필수	형식	Description
kind	True	string: SentimentAnalysis	수행할 작업의 종류입니다.
analysisInput		MultiLanguageAnalysisInput	입력 문서를 포함합니다.
parameters		SentimentAnalysisTaskParameters	감정 분석 작업 매개 변수입니다.

응답

Name	형식	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	요청이 성공했습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다. Headers x-ms-error-code: string

Name

형식

Description

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

요청이 성공했습니다.

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

Headers

x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

예제

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-05"
  }
}

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

정의

Name	Description
AnalyzeTextEntityLinkingInput	엔터티 연결 입력 분석 텍스트를 포함합니다.
AnalyzeTextEntityRecognitionInput	엔터티 인식은 텍스트 입력 작업 요청을 분석합니다.
AnalyzeTextKeyPhraseExtractionInput	분석 텍스트 KeyPhraseExtraction 작업 입력을 포함합니다.
AnalyzeTextLanguageDetectionInput	언어 감지 문서 분석 작업 입력을 포함합니다.
AnalyzeTextPiiEntitiesRecognitionInput	PIIEntityRecognition 작업 입력 분석 텍스트를 포함합니다.
AnalyzeTextSentimentAnalysisInput	SentimentAnalysis 작업 입력 분석 텍스트를 포함합니다.
AnalyzeTextTaskKind	지원되는 분석 텍스트 작업의 종류입니다.
AnalyzeTextTaskResultsKind	분석 텍스트 작업에서 반환된 응답 개체의 종류입니다.
DetectedLanguage	텍스트에 대해 검색된 언어의 세부 정보를 포함합니다.
DocumentError	작업 실행 중에 발생한 오류에 대한 세부 정보를 포함합니다.
DocumentSentimentValue	문서에 대한 예측 감정(음수, 중립, 긍정 또는 혼합)입니다.
DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
DocumentWarning	처리된 문서에 대한 경고가 발생한 경고 개체를 포함합니다.
EntitiesDocumentResult	문서에 대한 엔터티 인식 작업 결과를 포함합니다.
EntitiesResult	엔터티 인식 작업 결과를 포함합니다.
EntitiesTaskParameters	엔터티 인식 작업에 지원되는 매개 변수입니다.
EntitiesTaskResult	엔터티 작업을 포함합니다.
Entity	검색된 엔터티 범주 및 엔터티 텍스트 등을 포함하는 검색된 엔터티 개체를 정의합니다.
EntityLinkingResult	엔터티 연결 결과입니다.
EntityLinkingTaskParameters	엔터티 연결 작업에 지원되는 매개 변수입니다.
EntityLinkingTaskResult	분석 텍스트 엔터티 연결 작업 결과를 포함합니다.
Error	서비스가 요청을 처리하는 동안 일부 오류가 발생할 때 반환되는 오류 응답 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	KeyPhraseResult를 포함합니다.
KeyPhrasesDocumentResult	문서에 대한 핵심 구 추출 결과를 포함합니다.
KeyPhraseTaskParameters	핵심 구 추출 작업에 지원되는 매개 변수입니다.
KeyPhraseTaskResult	KeyPhraseExtraction 작업 결과 분석 텍스트를 포함합니다.
LanguageDetectionAnalysisInput	언어 감지 문서 분석 입력을 포함합니다.
LanguageDetectionDocumentResult	문서에 대한 언어 검색을 포함합니다.
LanguageDetectionResult	요청에 대한 언어 검색 결과를 포함합니다.
LanguageDetectionTaskParameters	언어 감지 작업에 지원되는 매개 변수입니다.
LanguageDetectionTaskResult	요청에 대한 언어 검색 작업 결과를 포함합니다.
LanguageInput	언어 검색 입력을 포함합니다.
LinkedEntitiesDocumentResult	문서 결과를 연결하는 엔터티입니다.
LinkedEntity	연결된 원본/링크가 있는 검색된 엔터티를 포함하는 LinkedEntity 개체입니다.
Match	오프셋 및 길이가 있는 검색된 엔터티 텍스트를 포함하는 Match 개체입니다.
MultiLanguageAnalysisInput	서비스에서 분석할 입력 문서의 컬렉션입니다.
MultiLanguageInput	서비스에서 분석할 입력 문서를 포함합니다.
PiiCategory	(선택 사항)은 반환할 PII 범주를 설명합니다.
PiiDomain	PII용 도메인 작업
PiiEntitiesDocumentResult	PII 결과를 포함합니다.
PiiResult	PiiResult를 포함합니다.
PiiTaskParameters	PII 엔터티 인식 작업에 지원되는 매개 변수입니다.
PiiTaskResult	PIIEntityRecognition LRO 작업 분석 텍스트를 포함합니다.
RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.
SentenceAssessment	문장 평가 및 관련 평가 또는 대상 개체를 나타냅니다.
SentenceSentiment	문서의 문장 감정입니다.
SentenceSentimentValue	문장에 대한 예측 감정입니다.
SentenceTarget	문장 대상과 관련된 평가 또는 대상 개체를 나타냅니다.
SentimentAnalysisTaskParameters	감정 분석 작업에 지원되는 매개 변수입니다.
SentimentConfidenceScores	모든 감정 클래스에서 긍정, 중립, 부정의 신뢰도 점수를 0에서 1 사이로 나타냅니다.
SentimentDocumentResult	각 문서의 미리 작성된 감정 분석 결과를 나타내는 개체입니다.
SentimentResponse	입력 문서에 대한 감정 분석 결과입니다.
SentimentTaskResult	SentimentAnalysis LRO 작업 결과 분석 텍스트를 포함합니다.
StringIndexType	문자열 인덱스 형식
TargetConfidenceScoreLabel	모든 감정 클래스의 신뢰도 점수(긍정 및 부정)를 나타냅니다.
TargetRelation	평가 및/또는 대상 간의 관계를 나타냅니다.
TargetRelationType	대상과 관련된 형식입니다.
TokenSentimentValue	문장에 대한 예측 감정입니다.
WarningCodeValue	경고 코드 목록을 정의합니다.

AnalyzeTextEntityLinkingInput

엔터티 연결 입력 분석 텍스트를 포함합니다.

Name	형식	Description
analysisInput	MultiLanguageAnalysisInput	서비스에서 처리할 분석 입력을 포함합니다.
kind	string: EntityLinking	수행할 작업의 종류입니다.
parameters	EntityLinkingTaskParameters	작업 매개 변수입니다.

AnalyzeTextEntityRecognitionInput

엔터티 인식은 텍스트 입력 작업 요청을 분석합니다.

Name	형식	Description
analysisInput	MultiLanguageAnalysisInput	분석할 입력입니다.
kind	string: EntityRecognition	수행할 작업의 종류입니다.
parameters	EntitiesTaskParameters	작업 매개 변수입니다.

AnalyzeTextKeyPhraseExtractionInput

분석 텍스트 KeyPhraseExtraction 작업 입력을 포함합니다.

Name	형식	Description
analysisInput	MultiLanguageAnalysisInput	입력 문서를 포함합니다.
kind	string: KeyPhraseExtraction	수행할 작업의 종류입니다.
parameters	KeyPhraseTaskParameters	핵심 구 추출 작업 매개 변수입니다.

AnalyzeTextLanguageDetectionInput

언어 감지 문서 분석 작업 입력을 포함합니다.

Name	형식	Description
analysisInput	LanguageDetectionAnalysisInput	분석할 문서입니다.
kind	string: LanguageDetection	수행할 작업의 종류입니다.
parameters	LanguageDetectionTaskParameters	작업 매개 변수입니다.

AnalyzeTextPiiEntitiesRecognitionInput

PIIEntityRecognition 작업 입력 분석 텍스트를 포함합니다.

Name	형식	Description
analysisInput	MultiLanguageAnalysisInput	입력 문서를 포함합니다.
kind	string: PiiEntityRecognition	수행할 작업의 종류입니다.
parameters	PiiTaskParameters	Pii 작업 매개 변수입니다.

AnalyzeTextSentimentAnalysisInput

SentimentAnalysis 작업 입력 분석 텍스트를 포함합니다.

Name	형식	Description
analysisInput	MultiLanguageAnalysisInput	입력 문서를 포함합니다.
kind	string: SentimentAnalysis	수행할 작업의 종류입니다.
parameters	SentimentAnalysisTaskParameters	감정 분석 작업 매개 변수입니다.

AnalyzeTextTaskKind

지원되는 분석 텍스트 작업의 종류입니다.

Name	형식	Description
EntityLinking	string	엔터티 연결 작업
EntityRecognition	string	엔터티 인식 작업
KeyPhraseExtraction	string	핵심 구 추출 작업
LanguageDetection	string	언어 감지 작업
PiiEntityRecognition	string	PII 엔터티 인식 작업
SentimentAnalysis	string	감정 분석 작업

AnalyzeTextTaskResultsKind

분석 텍스트 작업에서 반환된 응답 개체의 종류입니다.

Name	형식	Description
EntityLinkingResults	string	엔터티 연결 결과
EntityRecognitionResults	string	엔터티 인식 결과
KeyPhraseExtractionResults	string	핵심 구 추출 결과
LanguageDetectionResults	string	언어 검색 결과
PiiEntityRecognitionResults	string	PII 엔터티 인식 결과
SentimentAnalysisResults	string	감정 분석 결과

DetectedLanguage

텍스트에 대해 검색된 언어의 세부 정보를 포함합니다.

Name	형식	Description
confidenceScore	number	신뢰도 점수는 0에서 1 사이입니다. 점수가 1에 가까울수록 식별된 언어가 true라는 100% 확실성을 나타냅니다.
iso6391Name	string	ISO 639-1 표준(예: en, fr)에 따라 검색된 언어의 두 문자 표현입니다.
name	string	검색된 언어의 긴 이름(예: 영어, 프랑스어)입니다.

DocumentError

작업 실행 중에 발생한 오류에 대한 세부 정보를 포함합니다.

Name	형식	Description
error	Error	오류가 발생했습니다.
id	string	입력 문서의 ID입니다.

DocumentSentimentValue

문서에 대한 예측 감정(음수, 중립, 긍정 또는 혼합)입니다.

Name	형식	Description
mixed	string	혼합 문
negative	string	음수 문
neutral	string	중립 문
positive	string	양수 문

DocumentStatistics

showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.

Name	형식	Description
charactersCount	integer	문서에서 인식되는 텍스트 요소의 수입니다.
transactionsCount	integer	문서의 트랜잭션 수입니다.

DocumentWarning

처리된 문서에 대한 경고가 발생한 경고 개체를 포함합니다.

Name	형식	Description
code	WarningCodeValue	경고 코드입니다.
message	string	경고 메시지입니다.
targetRef	string	대상 개체를 나타내는 JSON 포인터 참조입니다.

EntitiesDocumentResult

문서에 대한 엔터티 인식 작업 결과를 포함합니다.

Name	형식	Description
entities	Entity[]	문서에서 인식된 엔터티입니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

EntitiesResult

엔터티 인식 작업 결과를 포함합니다.

Name	형식	Description
documents	EntitiesDocumentResult[]	문서별 응답
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

EntitiesTaskParameters

엔터티 인식 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전
stringIndexType	StringIndexType	TextElements_v8	(선택 사항) 문자열 오프셋을 해석하는 데 사용되는 문자열 인덱스 형식을 제공하는 매개 변수입니다. 기본값은 TextElements(Graphemes)입니다.

EntitiesTaskResult

엔터티 작업을 포함합니다.

Name	형식	Description
kind	string: EntityRecognitionResults	작업 결과의 종류입니다.
results	EntitiesResult	엔터티 인식에 대한 결과입니다.

Entity

검색된 엔터티 범주 및 엔터티 텍스트 등을 포함하는 검색된 엔터티 개체를 정의합니다.

Name	형식	Description
category	string	엔터티 형식입니다.
confidenceScore	number	추출된 엔터티의 신뢰도 점수는 0에서 1 사이입니다.
length	integer	엔터티 텍스트의 길이입니다. 다른 'stringIndexType' 값을 사용하면 반환되는 길이에 영향을 줄 수 있습니다.
offset	integer	엔터티 텍스트의 시작 위치입니다. 다른 'stringIndexType' 값을 사용하면 반환된 오프셋에 영향을 줄 수 있습니다.
subcategory	string	(선택 사항) 엔터티 하위 형식입니다.
text	string	요청에 나타나는 엔터티 텍스트입니다.

EntityLinkingResult

엔터티 연결 결과입니다.

Name	형식	Description
documents	LinkedEntitiesDocumentResult[]	문서별 응답
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

EntityLinkingTaskParameters

엔터티 연결 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전
stringIndexType	StringIndexType	TextElements_v8	문자열 오프셋을 해석하는 데 사용되는 문자열 인덱스 형식을 제공하는 선택적 매개 변수입니다. 기본값은 TextElements(Graphemes)입니다.

EntityLinkingTaskResult

분석 텍스트 엔터티 연결 작업 결과를 포함합니다.

Name	형식	Description
kind	string: EntityLinkingResults	작업 결과의 종류입니다.
results	EntityLinkingResult	엔터티 연결 결과입니다.

Error

서비스가 요청을 처리하는 동안 일부 오류가 발생할 때 반환되는 오류 응답 개체입니다.

Name	형식	Description
code	ErrorCode	서버 정의 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
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	Error	Error 개체.

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	InnerErrorCode	서버 정의 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

KeyPhraseResult

KeyPhraseResult를 포함합니다.

Name	형식	Description
documents	KeyPhrasesDocumentResult[]	문서별 응답
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

KeyPhrasesDocumentResult

문서에 대한 핵심 구 추출 결과를 포함합니다.

Name	형식	Description
id	string	비어 있지 않은 고유한 문서 식별자입니다.
keyPhrases	string[]	대표 단어 또는 구 목록입니다. 반환되는 핵심 구의 수는 입력 문서의 단어 수에 비례합니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

KeyPhraseTaskParameters

핵심 구 추출 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전

KeyPhraseTaskResult

KeyPhraseExtraction 작업 결과 분석 텍스트를 포함합니다.

Name	형식	Description
kind	string: KeyPhraseExtractionResults	작업 결과의 종류입니다.
results	KeyPhraseResult	핵심 구 추출 결과 목록

LanguageDetectionAnalysisInput

언어 감지 문서 분석 입력을 포함합니다.

Name	형식	Description
documents	LanguageInput[]	분석할 문서 목록입니다.

LanguageDetectionDocumentResult

문서에 대한 언어 검색을 포함합니다.

Name	형식	Description
detectedLanguage	DetectedLanguage	검색된 언어입니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

LanguageDetectionResult

요청에 대한 언어 검색 결과를 포함합니다.

Name	형식	Description
documents	LanguageDetectionDocumentResult[]	각 입력 문서에 대한 언어 검색 결과의 열거형입니다.
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

LanguageDetectionTaskParameters

언어 감지 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전

LanguageDetectionTaskResult

요청에 대한 언어 검색 작업 결과를 포함합니다.

Name	형식	Description
kind	string: LanguageDetectionResults	작업 결과의 종류입니다.
results	LanguageDetectionResult	언어 검색 결과를 포함합니다.

LanguageInput

언어 검색 입력을 포함합니다.

Name	형식	Description
countryHint	string	텍스트의 언어 감지에 도움이 되는 국가 힌트입니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
text	string	처리할 입력 텍스트입니다.

LinkedEntitiesDocumentResult

문서 결과를 연결하는 엔터티입니다.

Name	형식	Description
entities	LinkedEntity[]	문서에서 잘 알려진 엔터티를 인식합니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

LinkedEntity

연결된 원본/링크가 있는 검색된 엔터티를 포함하는 LinkedEntity 개체입니다.

Name	형식	Description
bingId	string	Bing Entity Search API 인식된 엔터티의 고유 식별자입니다.
dataSource	string	Wiki/Bing 등과 같은 엔터티 연결을 추출하는 데 사용되는 데이터 원본입니다.
id	string	데이터 원본에서 인식된 엔터티의 고유 식별자입니다.
language	string	데이터 원본에 사용되는 언어입니다.
matches	Match[]	이 엔터티가 텍스트에 표시되는 인스턴스 목록입니다.
name	string	엔터티 링크 형식 이름입니다.
url	string	데이터 원본에서 엔터티 페이지의 URL입니다.

Match

오프셋 및 길이가 있는 검색된 엔터티 텍스트를 포함하는 Match 개체입니다.

Name	형식	Description
confidenceScore	number	잘 알려진 항목이 인식되면 0에서 1 사이의 신뢰도 수준을 나타내는 10진수가 반환됩니다.
length	integer	엔터티의 길이가 텍스트와 일치합니다.
offset	integer	엔터티 일치 텍스트의 시작 위치입니다.
text	string	요청에 나타나는 엔터티 텍스트입니다.

MultiLanguageAnalysisInput

서비스에서 분석할 입력 문서의 컬렉션입니다.

Name	형식	Description
documents	MultiLanguageInput[]	분석할 입력 문서입니다.

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 여권 번호
AUTaxFileNumber	string	AU 세금 파일 번호
Address	string	주소
Age	string	Age
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 상태 서비스 번호
CAPassportNumber	string	CA 여권 번호
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	Date
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 세금 식별 번호
Email	string	메일
FIEuropeanHealthNumber	string	FI 유럽 건강 번호
FINationalID	string	FI 국가 ID
FINationalIDV2	string	FI 국가 ID V2
FIPassportNumber	string	FI 여권 번호
FRDriversLicenseNumber	string	FR 운전 면허증 번호
FRHealthInsuranceNumber	string	FR Health Insurance Number
FRNationalID	string	FR National 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 여권 번호
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 국가 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 여권 번호 국내
RUPassportNumberInternational	string	RU Passport Number International
SANationalID	string	SA 국가 ID
SENationalID	string	SE 국가 ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	SE 여권 번호
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	개인 건강 정보 도메인의 엔터티를 수정해야 했음을 나타냅니다.

PiiEntitiesDocumentResult

PII 결과를 포함합니다.

Name	형식	Description
entities	Entity[]	문서에서 인식된 엔터티입니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
redactedText	string	수정된 텍스트를 반환합니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

PiiResult

PiiResult를 포함합니다.

Name	형식	Description
documents	PiiEntitiesDocumentResult[]	문서별 응답
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

PiiTaskParameters

PII 엔터티 인식 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
domain	PiiDomain	none	PII 작업용 도메인
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전
piiCategories	PiiCategory[]		응답에 반환할 PII 범주의 열거형입니다.
stringIndexType	StringIndexType	TextElements_v8	분석에 사용할 StringIndexType입니다.

PiiTaskResult

PIIEntityRecognition LRO 작업 분석 텍스트를 포함합니다.

Name	형식	Description
kind	string: PiiEntityRecognitionResults	작업 결과의 종류입니다.
results	PiiResult	pii 결과 목록

RequestStatistics

showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

Name	형식	Description
documentsCount	integer	요청에 제출된 문서 수입니다.
erroneousDocumentsCount	integer	잘못된 문서 수입니다. 여기에는 빈 크기 제한 또는 지원되지 않는 언어 문서가 포함됩니다.
transactionsCount	integer	요청에 대한 트랜잭션 수입니다.
validDocumentsCount	integer	유효한 문서 수입니다. 이렇게 하면 빈, 크기 초과 제한 또는 지원되지 않는 언어 문서가 제외됩니다.

SentenceAssessment

문장 평가 및 관련 평가 또는 대상 개체를 나타냅니다.

Name	형식	Description
confidenceScores	TargetConfidenceScoreLabel	모든 감정 클래스의 신뢰도 점수(긍정 및 부정)를 나타냅니다.
isNegated	boolean	평가가 무효화되는지를 나타내는 표시기입니다.
length	integer	대상의 길이입니다.
offset	integer	문장의 시작부터의 대상 오프셋입니다.
sentiment	TokenSentimentValue	문장의 감정입니다.
text	string	검색된 대상 텍스트입니다.

SentenceSentiment

문서의 문장 감정입니다.

Name	형식	Description
assessments	SentenceAssessment[]	문장에 대한 평가 배열입니다.
confidenceScores	SentimentConfidenceScores	모든 클래스에 대한 문장의 감정 신뢰도 점수는 0에서 1 사이입니다.
length	integer	대상의 길이입니다.
offset	integer	문장의 시작부터의 대상 오프셋입니다.
sentiment	SentenceSentimentValue	문장에 대한 예측 감정입니다.
targets	SentenceTarget[]	문장 대상의 배열입니다.
text	string	문장 텍스트입니다.

SentenceSentimentValue

문장에 대한 예측 감정입니다.

Name	형식	Description
negative	string	부정적인 감정
neutral	string	중립 정서
positive	string	긍정적인 감정

SentenceTarget

문장 대상과 관련된 평가 또는 대상 개체를 나타냅니다.

Name	형식	Description
confidenceScores	TargetConfidenceScoreLabel	모든 감정 클래스의 신뢰도 점수(긍정 및 부정)를 나타냅니다.
length	integer	대상의 길이입니다.
offset	integer	문장의 시작부터의 대상 오프셋입니다.
relations	TargetRelation[]	대상과 관련된 평가 또는 대상 개체의 배열입니다.
sentiment	TokenSentimentValue	문장의 감정입니다.
text	string	검색된 대상 텍스트입니다.

SentimentAnalysisTaskParameters

감정 분석 작업에 지원되는 매개 변수입니다.

Name	형식	기본값	Description
loggingOptOut	boolean	False	로깅 옵트아웃
modelVersion	string	latest	모델 버전
opinionMining	boolean	False	요청에 오피니언 마이닝을 사용할지 여부입니다.
stringIndexType	StringIndexType	TextElements_v8	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다.

SentimentConfidenceScores

모든 감정 클래스에서 긍정, 중립, 부정의 신뢰도 점수를 0에서 1 사이로 나타냅니다.

Name	형식	Description
negative	number	부정적인 감정에 대한 신뢰도 점수
neutral	number	중립 정서에 대한 신뢰도 점수
positive	number	긍정적인 감정에 대한 신뢰도 점수

SentimentDocumentResult

각 문서의 미리 작성된 감정 분석 결과를 나타내는 개체입니다.

Name	형식	Description
confidenceScores	SentimentConfidenceScores	모든 클래스에 대한 문장의 감정 신뢰도 점수는 0에서 1 사이입니다.
id	string	비어 있지 않은 고유한 문서 식별자입니다.
sentences	SentenceSentiment[]	문서의 문장 감정입니다.
sentiment	DocumentSentimentValue	문서에 대한 예측 감정(음수, 중립, 긍정 또는 혼합)입니다.
statistics	DocumentStatistics	showStats=true가 요청에 지정되었으면 이 필드에 문서 페이로드에 대한 정보가 포함됩니다.
warnings	DocumentWarning[]	문서를 처리하는 동안 경고가 발생했습니다.

SentimentResponse

입력 문서에 대한 감정 분석 결과입니다.

Name	형식	Description
documents	SentimentDocumentResult[]	입력의 각 문서에 대한 감정 분석 결과입니다.
errors	DocumentError[]	문서 ID별 오류입니다.
modelVersion	string	이 필드는 채점에 사용되는 모델을 나타냅니다.
statistics	RequestStatistics	showStats=true가 요청에 지정되었으면 이 필드에 요청 페이로드에 대한 정보가 포함됩니다.

SentimentTaskResult

SentimentAnalysis LRO 작업 결과 분석 텍스트를 포함합니다.

Name	형식	Description
kind	string: SentimentAnalysisResults	작업 결과의 종류입니다.
results	SentimentResponse	감정 분석 결과

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)로 작성된 경우 이 옵션을 사용합니다.

TargetConfidenceScoreLabel

모든 감정 클래스의 신뢰도 점수(긍정 및 부정)를 나타냅니다.

Name	형식	Description
negative	number	부정적인 감정에 대한 신뢰도 점수
positive	number	긍정적인 감정에 대한 신뢰도 점수

TargetRelation

평가 및/또는 대상 간의 관계를 나타냅니다.

Name	형식	Description
ref	string	연결된 개체를 나타내는 JSON 포인터입니다.
relationType	TargetRelationType	대상과 관련된 형식입니다.

TargetRelationType

대상과 관련된 형식입니다.

Name	형식	Description
assessment	string	평가 관계.
target	string	대상 관계입니다.

TokenSentimentValue

문장에 대한 예측 감정입니다.

Name	형식	Description
mixed	string	혼합 감정
negative	string	부정적인 감정
positive	string	긍정적인 감정

WarningCodeValue

경고 코드 목록을 정의합니다.

Name	형식	Description
DocumentTruncated	string	잘린 경고 문서화
LongWordsInDocument	string	문서 경고의 긴 단어

다음을 통해 공유

Text Analysis Runtime - Analyze Text

URI 매개 변수

요청 헤더

요청 본문

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

응답

보안

Ocp-Apim-Subscription-Key

예제

SuccessfulEntityLinkingRequest

Sample Request

Sample Response

SuccessfulEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulKeyPhraseExtractionRequest

Sample Request

Sample Response

SuccessfulLanguageDetectionRequest

Sample Request

Sample Response

SuccessfulPiiEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulSentimentAnalysisRequest

Sample Request

Sample Response

정의

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

KeyPhraseResult

KeyPhrasesDocumentResult

KeyPhraseTaskParameters

KeyPhraseTaskResult

LanguageDetectionAnalysisInput

LanguageDetectionDocumentResult

LanguageDetectionResult

LanguageDetectionTaskParameters

LanguageDetectionTaskResult

LanguageInput

LinkedEntitiesDocumentResult

LinkedEntity

Match

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiEntitiesDocumentResult

PiiResult

PiiTaskParameters