API 작성

  • 아티클

사용자 지정 질문 답변 작성 API는 새 질문 답변 쌍 추가, 프로젝트 만들기, 게시 및 기본 같은 일반적인 작업을 자동화하는 데 사용됩니다.

참고 항목

작성 기능은 REST API 및 작성 SDK(미리 보기)를 통해 사용할 수 있습니다. 이 문서에서는 cURL에서 REST API를 사용하는 예제를 제공합니다. 사용 가능한 모든 매개 변수 및 기능에 대한 전체 문서는 REST API 참조 콘텐츠를 참조하세요.

필수 조건

  • 현재 버전의 cURL. 이 문서에는 몇 가지 명령줄 스위치가 사용되며, 이러한 스위치는 cURL 설명서에 나와 있습니다.
  • 이 문서의 명령은 Bash 셸에서 실행되도록 설계되었습니다. 이러한 명령 중 일부는 수정한 후에 Windows 명령 프롬프트 또는 PowerShell에서 작동해야 합니다. Bash 셸이 로컬로 설치되지 않은 경우 Azure Cloud Shell의 bash 환경을 사용할 수 있습니다.

프로젝트 만들기

프로그래밍 방식으로 프로젝트를 만들려면:

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이전 예제가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
NEW-PROJECT-NAME 새 사용자 지정 질문 답변 프로젝트의 이름입니다.

또한 프로젝트 언어, 신뢰도 임계값을 충족하거나 초과하는 답변을 찾을 수 없을 때 제공되는 기본 답변, 이 언어 리소스에서 여러 언어를 지원하는지 여부와 같은 추가 값을 조정할 수 있습니다.

예제 쿼리

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "description": "proj1 is a test project.",
      "language": "en",
      "settings": {
        "defaultAnswer": "No good match found for your question in the project."
      },
      "multilingualResource": true
    }
  }'  'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{NEW-PROJECT-NAME}?api-version=2021-10-01'

예제 응답

{
 "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "multilingualResource": true,
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
 }
}

프로젝트를 삭제합니다.

프로그래밍 방식으로 프로젝트를 삭제하려면:

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이전 예제가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 삭제할 프로젝트의 이름입니다.

예제 쿼리

curl -X DELETE -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

프로젝트를 삭제하기 위한 호출이 성공하면 프로젝트 삭제 작업의 상태를 확인하는 데 사용할 수 있는 Operation-Location 헤더가 반환됩니다. 대부분의 예제에서 응답 헤더를 확인할 필요가 없으므로 표시되지 않았습니다. 응답 헤더를 검색하기 위해 curl 명령에서 -i를 사용합니다. 이 매개 변수가 엔드포인트 주소 앞에 없으면 응답이 수행되지 않은 것처럼 이 명령에 대한 응답이 빈 상태로 표시됩니다.

예제 응답

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 324
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:56:18 GMT

프로젝트를 이미 삭제했거나 찾을 수 없는 경우 다음과 같은 메시지가 표시됩니다.

{
  "error": {
    "code": "ProjectNotFound",
    "message": "The specified project was not found.",
    "details": [
      {
        "code": "ProjectNotFound",
        "message": "{GUID}"
      }
    ]
  }
}

프로젝트 삭제 상태 가져오기

프로젝트 삭제 요청의 상태를 확인하려면 다음을 수행합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 배포 상태를 확인할 프로젝트의 이름입니다.
JOB-ID 프로그래밍 방식으로 프로젝트를 삭제하면 삭제 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/deletion-jobs/{JOB-ID}?api-version=2021-10-01'

예제 응답

{
  "createdDateTime": "2021-11-23T20:56:18+00:00",
  "expirationDateTime": "2021-11-24T02:56:18+00:00",
  "jobId": "GUID",
  "lastUpdatedDateTime": "2021-11-23T20:56:18+00:00",
  "status": "succeeded"
}

프로젝트 설정 가져오기

지정된 프로젝트에 대한 정보를 쿼리하려면 아래 쿼리에서 다음 값을 업데이트합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 정보를 검색하려는 프로젝트의 이름입니다.

예제 쿼리


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

예제 응답

 {
    "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
    }
  }

질문 답변 쌍 가져오기

지정된 프로젝트에 대한 질문 답변 쌍 및 관련 정보를 쿼리하려면 아래 쿼리에서 다음 값을 업데이트합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 모든 질문 답변 쌍을 검색하려는 프로젝트의 이름입니다.

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

예제 응답

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "id": 1,
            "answer": "ans1",
            "source": "source1",
            "questions": [
              "question 1.1",
              "question 1.2"
            ],
            "metadata": {
              "k1": "v1",
              "k2": "v2"
            },
            "dialog": {
              "isContextOnly": false,
              "prompts": [
                {
                  "displayOrder": 1,
                  "qnaId": 11,
                  "displayText": "prompt 1.1"
                },
                {
                  "displayOrder": 2,
                  "qnaId": 21,
                  "displayText": "prompt 1.2"
                }
              ]
            },
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          },
          {
            "id": 2,
            "answer": "ans2",
            "source": "source2",
            "questions": [
              "question 2.1",
              "question 2.2"
            ],
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          }
        ]
      }
    }
  }

원본 가져오기

지정된 프로젝트에 대한 원본 및 관련 정보를 쿼리하려면 아래 쿼리에서 다음 값을 업데이트합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 모든 원본 정보를 검색하려는 프로젝트의 이름입니다.

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT_NAME}/sources?api-version=2021-10-01'

예제 응답

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "displayName": "source1",
            "sourceUri": "https://learn.microsoft.com/azure/ai-services/qnamaker/overview/overview",
            "sourceKind": "url",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          },
          {
            "displayName": "source2",
            "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
            "sourceKind": "file",
            "contentStructureKind": "unstructured",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          }
        ]
      }
    }
  }

동의어 가져오기

지정된 프로젝트에 대한 동의어 및 관련 정보를 쿼리하려면 아래 쿼리에서 다음 값을 업데이트합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 동의어 정보를 검색하려는 프로젝트의 이름입니다.

예제 쿼리


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

예제 응답

 {
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "alterations": [
              "qnamaker",
              "qna maker"
            ]
          },
          {
            "alterations": [
              "botframework",
              "bot framework"
            ]
          }
        ]
      }
    }
  }

프로젝트 배포

프로덕션에 프로젝트를 배포하려면 아래 쿼리에서 다음 값을 업데이트합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 프로덕션에 배포하려는 프로젝트의 이름입니다.

예제 쿼리

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production?api-version=2021-10-01'

프로젝트를 배포하기 위한 호출이 성공하면 배포 작업의 상태를 확인하는 데 사용할 수 있는 Operation-Location 헤더가 반환됩니다. 대부분의 예제에서 응답 헤더를 확인할 필요가 없으므로 표시되지 않았습니다. 응답 헤더를 검색하기 위해 curl 명령에서 -i를 사용합니다. 이 매개 변수가 엔드포인트 주소 앞에 없으면 응답이 수행되지 않은 것처럼 이 명령에 대한 응답이 빈 상태로 표시됩니다.

예제 응답

0HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 31
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:35:00 GMT

프로젝트 배포 상태 가져오기

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 배포 상태를 확인할 프로젝트의 이름입니다.
JOB-ID 프로그래밍 방식으로 프로젝트를 배포하면 배포 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production/jobs/{JOB-ID}?api-version=2021-10-01'

예제 응답

    {
    "200": {
      "headers": {},
      "body": {
        "errors": [],
        "createdDateTime": "2021-05-01T17:21:14Z",
        "expirationDateTime": "2021-05-01T17:21:14Z",
        "jobId": "{JOB-ID-GUID}",
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "status": "succeeded"
      }
    }
  }

프로젝트 메타데이터 및 자산 내보내기

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 내보낼 프로젝트의 이름입니다.

예제 쿼리

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{exportAssetTypes": ["qnas","synonyms"]}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:export?api-version=2021-10-01&format=tsv'

예제 응답

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/export/jobs/{JOB-ID_GUID}
x-envoy-upstream-service-time: 214
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 21:24:03 GMT

내보내기 상태 확인

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 내보내기 상태를 확인하려는 프로젝트의 이름입니다.
JOB-ID 프로그래밍 방식으로 프로젝트를 내보낼 때 내보내기 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID}?api-version=2021-10-01'

예제 응답

{
  "createdDateTime": "2021-11-23T21:24:03+00:00",
  "expirationDateTime": "2021-11-24T03:24:03+00:00",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-11-23T21:24:08+00:00",
  "status": "succeeded",
  "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"
}

resultUrl에 직접 액세스하려고 하면 404 오류가 발생합니다. 인증된 요청에서 액세스할 수 있도록 하려면 다음과 같이 ?api-version=2021-10-01를 경로에 추가해야 합니다. https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

프로젝트 가져오기

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 가져오기 대상이 될 프로젝트의 이름입니다.
FILE-URI-PATH 프로그래밍 방식으로 프로젝트를 내보낸 다음 내보내기 상태를 확인하면 응답의 일부로 resultUrl이 생성됩니다. 예를 들어 "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"입니다. API 버전이 추가된 resultUrl을 원본 파일로 사용하여 다음 위치에서 프로젝트를 가져올 수 있습니다. https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

예제 쿼리

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "fileUri": "FILE-URI-PATH"
  }' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:import?api-version=2021-10-01&format=tsv'

프로젝트 가져오기 호출에 성공하면 가져오기 작업의 상태를 확인하는 데 사용할 수 있는 Operation-Location 헤더가 반환됩니다. 대부분의 예제에서 응답 헤더를 확인할 필요가 없으므로 표시되지 않았습니다. 응답 헤더를 검색하기 위해 curl 명령에서 -i를 사용합니다. 이 추가 매개 변수가 엔드포인트 주소 앞에 없으면 응답이 수행되지 않은 것처럼 이 명령에 대한 응답이 빈 상태로 표시됩니다.

예제 응답

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/import/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 417
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 00:35:11 GMT

가져오기 상태 확인

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 가져오기 대상이 될 프로젝트의 이름입니다.
JOB-ID 프로그래밍 방식으로 프로젝트를 가져오면 내보내기 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME/import/jobs/{JOB-ID-GUID}?api-version=2021-10-01'

예제 쿼리 응답

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

배포 나열

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 배포 목록을 생성하려는 프로젝트의 이름입니다.

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments?api-version=2021-10-01'

예제 응답

[
  {
    "deploymentName": "production",
    "lastDeployedDateTime": "2021-10-26T15:12:02Z"
  }
]

프로젝트 나열

계정에서 액세스할 수 있는 모든 질문 답변 프로젝트 목록을 검색합니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects?api-version=2021-10-01'

예제 응답

{
  "value": [
    {
      "projectName": "Sample-project",
      "description": "My first question answering project",
      "language": "en",
      "multilingualResource": false,
      "createdDateTime": "2021-10-07T04:51:15Z",
      "lastModifiedDateTime": "2021-10-27T00:42:01Z",
      "lastDeployedDateTime": "2021-11-24T01:34:18Z",
      "settings": {
        "defaultAnswer": "No good match found in KB"
      }
    }
  ]
}

원본 업데이트

이 예제에서는 새 원본을 기존 프로젝트에 추가합니다. 또한 쿼리 본문의 일부로 전달하는 작업의 종류에 따라 이 명령을 사용하여 기존 원본을 바꾸고 삭제할 수 있습니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 원본을 업데이트하려는 프로젝트의 이름입니다.
METHOD PATCH

예제 쿼리

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
  {
    "op": "add",
    "value": {
      "displayName": "source5",
      "sourceKind": "url",
      "sourceUri": "https://download.microsoft.com/download/7/B/1/7B10C82E-F520-4080-8516-5CF0D803EEE0/surface-book-user-guide-EN.pdf",
      "sourceContentStructureKind": "semistructured"
    }
  }
]'  -i '{LanguageServiceName}.cognitiveservices.azure.com//language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01'

원본을 업데이트하기 위한 호출이 성공하면 가져오기 작업의 상태를 확인하는 데 사용할 수 있는 Operation-Location 헤더가 반환됩니다. 대부분의 예제에서 응답 헤더를 확인할 필요가 없으므로 항상 표시되지는 않았습니다. 응답 헤더를 검색하기 위해 curl 명령에서 -i를 사용합니다. 이 매개 변수가 엔드포인트 주소 앞에 없으면 응답이 수행되지 않은 것처럼 이 명령에 대한 응답이 빈 상태로 표시됩니다.

예제 응답

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/sources/jobs/{JOB_ID_GUID}
x-envoy-upstream-service-time: 412
apim-request-id: dda23d2b-f110-4645-8bce-1a6f8d504b33
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 02:47:53 GMT

원본 업데이트 상태 가져오기

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 가져오기 대상이 될 프로젝트의 이름입니다.
JOB-ID 원본을 프로그래밍 방식으로 업데이트하면 원본 업데이트 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/sources/jobs/{JOB-ID}?api-version=2021-10-01'

예제 응답

{
  "createdDateTime": "2021-11-24T02:47:53+00:00",
  "expirationDateTime": "2021-11-24T08:47:53+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T02:47:56+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"
}

질문 및 답변 쌍 업데이트

이 예제에서는 질문 답변 쌍을 기존 원본에 추가합니다. 또한 쿼리 본문에서 전달하는 작업에 따라 이 쿼리를 사용하여 기존 질문 답변 쌍을 수정하거나 삭제할 수 있습니다. source5라는 원본이 없으면 이 예제 쿼리가 실패합니다. 쿼리 본문의 원본 값을 대상 프로젝트에 대해 존재하는 원본으로 조정할 수 있습니다.

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 가져오기 대상이 될 프로젝트의 이름입니다. 
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
    {
        "op": "add",
        "value":{
            "id": 1,
            "answer": "The latest question answering docs are on https://learn.microsoft.com",
            "source": "source5",
            "questions": [
                "Where do I find docs for question answering?"
            ],
            "metadata": {},
            "dialog": {
                "isContextOnly": false,
                "prompts": []
            }
        }
    }
]'  -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

질문 답변 쌍을 업데이트하기 위한 호출이 성공하면 업데이트 작업의 상태를 확인하는 데 사용할 수 있는 Operation-Location 헤더가 반환됩니다. 대부분의 예제에서 응답 헤더를 확인할 필요가 없으므로 항상 표시되지는 않았습니다. 응답 헤더를 검색하기 위해 curl 명령에서 -i를 사용합니다. 이 매개 변수가 엔드포인트 주소 앞에 없으면 응답이 수행되지 않은 것처럼 이 명령에 대한 응답이 빈 상태로 표시됩니다.

예제 응답

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/qnas/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 507
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:16:01 GMT

질문 답변 쌍 업데이트 상태 가져오기

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 질문 답변 쌍 업데이트의 대상이 될 프로젝트의 이름입니다.
JOB-ID 질문 답변 쌍을 프로그래밍 방식으로 업데이트하면 업데이트 요청에 대한 operation-location 응답 헤더의 일부로 JOB-ID가 생성됩니다. JOB-ID는 operation-location 끝에 있는 GUID입니다. 예: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

예제 쿼리

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas/jobs/{JOB-ID}?api-version=2021-10-01'

예제 응답

  "createdDateTime": "2021-11-24T03:16:01+00:00",
  "expirationDateTime": "2021-11-24T09:16:01+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T03:16:06+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"

동의어 업데이트

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 동의어를 추가하려는 프로젝트의 이름입니다.

예제 쿼리

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

예제 응답

0HTTP/2 200
content-length: 17
content-type: application/json; charset=utf-8
x-envoy-upstream-service-time: 39
apim-request-id: 5deb2692-dac8-43a8-82fe-36476e407ef6
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:59:09 GMT

{
  "value": []
}

활성 학습 피드백 업데이트

변수 이름 값
ENDPOINT 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 예제 엔드포인트는 https://southcentralus.api.cognitive.microsoft.com/입니다. 이 엔드포인트가 아래 코드 샘플의 엔드포인트인 경우 엔드포인트 경로의 나머지 부분이 이미 있으므로 southcentral의 지역 관련 부분만 추가하면 됩니다.
API-KEY 이 값은 Azure Portal에서 리소스를 검사할 때 키 및 엔드포인트 섹션에서 찾을 수 있습니다. Key1 또는 Key2를 사용할 수 있습니다. 항상 두 개의 유효한 키를 사용하면 가동 중지 시간이 0인 보안 키 회전을 허용합니다. 또는 Language Studio>질문 답변>프로젝트 배포>예측 URL 가져오기에서 값을 찾을 수 있습니다. 키 값은 샘플 요청의 일부입니다.
PROJECT-NAME 활성 학습 피드백 업데이트의 대상이 되고자 하는 프로젝트의 이름입니다.

예제 쿼리

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
records": [
    {
      "userId": "user1",
      "userQuestion": "hi",
      "qnaId": 1
    },
    {
      "userId": "user1",
      "userQuestion": "hello",
      "qnaId": 2
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/feedback?api-version=2021-10-01'

예제 응답

HTTP/2 204
x-envoy-upstream-service-time: 37
apim-request-id: 92225e03-e83f-4c7f-b35a-223b1b0f29dd
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 04:02:56 GMT