미리 빌드된 API

아티클
11/21/2024

사용자 지정 질문 답변 미리 빌드된 API를 사용하면 프로젝트를 만들거나 질문 및 답변 쌍을 유지 관리하거나 충분히 활용되지 않는 인프라에 대한 비용을 발생시키지 않고도 텍스트 구절을 기반으로 질문에 답변할 수 있습니다. 이 기능은 API로 제공되며 사용자 지정 질문 답변에 대한 세부 정보를 알아보지 않고도 질문 및 답변 요구 사항을 충족하는 데 사용할 수 있습니다.

사용자 쿼리 및 텍스트/구절 블록을 지정하면 API가 답변 및 정확한 답변(있는 경우)을 반환합니다.

API 사용량 예

지정된 질문에 대한 답변을 얻고자 하는 텍스트 블록이 하나 이상 있다고 가정하겠습니다. 일반적으로 텍스트 블록 수만큼 원본을 만들어야 했습니다. 그러나 이제 미리 빌드된 API를 사용하여 프로젝트에서 콘텐츠 원본을 정의하지 않고도 텍스트 블록을 쿼리할 수 있습니다.

이 API를 사용할 수 있는 다른 시나리오는 다음과 같습니다.

최종 사용자를 위한 전자책 리더 앱을 개발 중입니다. 이 앱을 사용하면 텍스트를 강조 표시하고, 질문을 입력하고, 강조 표시된 텍스트 구절에서 답변을 찾을 수 있습니다.
사용자가 브라우저 페이지에 현재 표시되고 있는 콘텐츠에 대한 질문을 할 수 있게 해주는 브라우저 확장
사용자의 쿼리를 받고 사용자 쿼리와 가장 관련성이 높은 것으로 식별된 의료 콘텐츠에 따라 답변을 제공하는 의료용 봇.

샘플 요청의 예는 다음과 같습니다.

샘플 요청

POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text

단일 텍스트 블록에 대한 샘플 쿼리

요청 본문

{
  "parameters": {
    "Endpoint": "{Endpoint}",
    "Ocp-Apim-Subscription-Key": "{API key}",
    "Content-Type": "application/json",
    "api-version": "2021-10-01",
    "stringIndexType": "TextElements_v8",
    "textQueryOptions": {
      "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"
    }
  }
}

샘플 응답

위의 요청 본문에서는 단일 텍스트 블록에 대해 쿼리합니다. 위의 쿼리에 대해 수신되는 샘플 응답은 다음과 같습니다.

{
"responses": {
    "200": {
      "headers": {},
      "body": {
        "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
          }
        ]
      }
    }
  }

API 응답의 일부로 여러 답변이 수신되는 것을 볼 수 있습니다. 각 답변에는 답변의 전반적인 관련성을 이해하는 데 도움이 되는 특정 신뢰도 점수가 있습니다. 답변 범위는 잠재적인 단답형도 검색되었는지 여부를 나타냅니다. 사용자는 이 신뢰도 점수를 사용하여 쿼리에 대한 답변으로 제공할 답변을 결정할 수 있습니다.

미리 작성된 API 제한 사항

API 호출 제한

허용 한도보다 크기가 큰 문서를 사용해야 하는 경우 텍스트를 API로 보내기 전에 큰 텍스트를 작은 텍스트 청크로 분할할 수 있습니다. 이 컨텍스트에서 문서는 텍스트 문자의 정의된 단일 문자열입니다.

다음 숫자는 개별 API 호출 한도를 나타냅니다.

문서 수: 5개
단일 문서의 최대 크기: 5,120자
문서당 최대 3개의 응답

지원되는 언어 코드

다음 언어 코드는 미리 빌드된 API에서 지원됩니다. 이러한 언어 코드는 ISO 639-1 코드 표준을 따릅니다.

언어 코드	언어
af	아프리칸스어
저는	암하라어
ar	아랍어
AS	아삼어
az	아제르바이잔어
ba	바슈키르어
be	벨로루시어
bg	불가리아어
bn	벵골어
ca	카탈루냐어, 발렌시아어
ckb	중앙 쿠르드어
cs	체코어
cy	웨일스어
da	덴마크어
de	독일어
el	그리스어, 현대(1453–)
en	영어
eo	Esperanto
es	스페인어, 카스티야어
et	에스토니아어
eu	바스크어
fa	페르시아어
fi	핀란드어
fr	프랑스어
ga	아일랜드어
gl	갈리시아어
gu	구자라트어
he	히브리어
hi	힌디어
시간	크로아티아어
hu	헝가리어
hy	아르메니아
id	인도네시아어
is	아이슬란드어
it	이탈리아어
ja	일본어
ka	그루지야 문자
kk	카자흐어
km	중앙 크메르어
kn	칸나다어
ko	한국어
ky	키르기스어, 키르기스어
la	라틴어
lo	라오스어
lt	리투아니아어
lv	라트비아어
mk	마케도니아어
ml	말라얄람어
mn	몽골어
mr	마라티어
밀리초	말레이어
mt	몰타어
내	Burmese
ne	네팔어
nl	네덜란드어, 플라망어
nn	노르웨이어(니노르스크)
아니요	노르웨이어
또는	오디아어
pa	펀잡어, 펀자브어
pl	폴란드어
ps	파슈토어, 파슈토
pt	포르투갈어
ro	루마니아어
ru	러시아어
sa	산스크리트어
sd	신디어
si	싱할라어, 싱할라어
sk	슬로바키아어
sl	슬로베니아어
sq	알바니아어
sr	세르비아어
sv	스웨덴어
sw	스와힐리어
ta	타밀어
te	텔루구어
tg	타지키스탄어
th	태국어
tl	타갈로그어
tr	터키어
tt	타타르어
ug	위구르어, 위구르어
uk	우크라이나어
ur	우르두어
uz	우즈베크어
vi	베트남어
yi	이디시어
zh	중국어

미리 작성된 API 참조

API 호출에 필요한 입력 및 출력 매개 변수를 이해하려면 미리 빌드된 API 샘플 전체 문서를 참조하세요.

다음을 통해 공유