Question Answering - Get Answers From Text

참조

서비스:: Cognitive Services - Language

API 버전:: 2023-04-01

본문에 제공된 텍스트를 사용하여 지정된 질문에 답변합니다.

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

URI 매개 변수

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

요청 본문

Name	필수	형식	Description
question	True	string	지정된 텍스트 레코드에 대해 쿼리할 사용자 질문입니다.
records	True	TextDocument[]	지정된 질문을 검색할 텍스트 레코드입니다.
language		string	텍스트 레코드의 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정되지 않은 경우 기본적으로 영어에 "en"을 사용합니다.
stringIndexType		StringIndexType	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 유니코드 v8.0.0에 따라 기본값은 텍스트 요소(Graphemes)입니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.

응답

Name	형식	Description
200 OK	AnswersFromTextResult	입력 텍스트에서 답변을 가져오는 성공적인 응답입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

AADToken

Azure Active Directory OAuth2 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하는 솔루션을 제공합니다.

참고

이 보안 정의는 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내기 위해 헤더를 사용해야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Azure Active Directory 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

현재 Azure Active Directory v1.0 또는 v2.0 은 회사, 학교 및 게스트를 지원하지만 개인 계정은 지원하지 않습니다.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

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

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

예제

Successful query

샘플 요청

HTTP

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

{
  "question": "how long it takes to charge surface?",
  "records": [
    {
      "id": "1",
      "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
    },
    {
      "id": "2",
      "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
    }
  ],
  "language": "en"
}

샘플 응답

상태 코드:: 200

{
  "answers": [
    {
      "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.93,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 28,
        "length": 45
      },
      "offset": 0,
      "length": 224
    },
    {
      "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.92,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 8,
        "length": 25
      },
      "offset": 20,
      "length": 224
    },
    {
      "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.05,
      "id": "1",
      "answerSpan": null,
      "offset": 110,
      "length": 244
    }
  ]
}

정의

Name	Description
AnswersFromTextOptions	답변할 질문 및 텍스트 레코드 매개 변수입니다.
AnswersFromTextResult	응답 결과를 나타냅니다.
AnswerSpan	QnA의 응답 범위 개체입니다.
Error	Error 개체.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 유니코드 v8.0.0에 따라 기본값은 텍스트 요소(Graphemes)입니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.
TextAnswer	응답 결과를 나타냅니다.
TextDocument	쿼리할 입력 텍스트 레코드를 나타냅니다.

AnswersFromTextOptions

답변할 질문 및 텍스트 레코드 매개 변수입니다.

Name	형식	Default value	Description
language	string		텍스트 레코드의 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에는 "en"을 사용합니다. 스페인어 등에 대한 "es". 설정되지 않은 경우 기본적으로 영어에 "en"을 사용합니다.
question	string		지정된 텍스트 레코드에 대해 쿼리할 사용자 질문입니다.
records	TextDocument[]		지정된 질문을 검색할 텍스트 레코드입니다.
stringIndexType	StringIndexType	TextElements_v8	문자열 오프셋을 해석하는 데 사용되는 메서드를 지정합니다. 유니코드 v8.0.0에 따라 기본값은 텍스트 요소(Graphemes)입니다. 자세한 내용은 https://aka.ms/text-analytics-offsets를 참조하십시오.

AnswersFromTextResult

응답 결과를 나타냅니다.

Name	형식	Description
answers	TextAnswer[]	응답 결과를 나타냅니다.

AnswerSpan

QnA의 응답 범위 개체입니다.

Name	형식	Description
confidenceScore	number	예측된 응답 범위 점수, 값 범위는 0에서 1까지입니다.
length	integer	응답 범위의 길이입니다.
offset	integer	답변 시작부터의 응답 범위 오프셋입니다.
text	string	응답 범위의 예측 텍스트입니다.

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 개체.

InnerErrorCode