Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Request to update guide on how to export/download Custom QA knowledge bases via REST API.

Đang mở
#168 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với hai trang Question Answering REST API được liên kết và lần theo quy trình xuất qua các bước operation-location và resultURL. Cập nhật hướng dẫn liên quan để giải thích rằng resultURL yêu cầu một request bổ sung, đồng thời mô tả quy trình tải xuống hoặc lưu response được thể hiện trong issue. Hoàn tất khi hướng dẫn bao quát chính xác toàn bộ quy trình xuất và tải xuống.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Please provide us with the following information:

This issue is for a: (mark with an x)
- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)
Minimal steps to reproduce

Please navigate to the following Custom QA REST API links.

When exporting Custom QA KB, the following APIs are issued.

  1. Custom QA Export API to export knowledge base
    https://learn.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects/get-export-status?tabs=HTTP

  2. The above API returns a URL in the operation-location header. Then, this may be used as a parameter to issue the Custom QA Get Export Status API to get the resultURL for download.
    https://learn.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering-projects/get-export-status?tabs=HTTP

In the 2nd step, it mentions that the purpose of Get Export Status API is to _"get the status of an Export job, once job completes, returns the project metadata, and assets.", which may be confusing for the user as the 2nd step only returns a resultURL for download. Then, an additional API request needs to be issued by using the resultURL value and subscription key. The additional step cannot be used to download the file directly from a browse for example, but it requires a tool like Postman to Send and Download the result to file. Or, by clicking Send to send the request and Save Response when a valid response is received. Please see the sample image below.

image

Thank you and hope you may consider the above suggestions for future enhancements!

Any log messages given by the failure
Expected/desired behavior
OS and Version?

Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)

Versions
Mention any other details that might be useful

Thanks! We'll be in touch soon.

Ngôn ngữ chính
HTML
Star
241
Fork
279
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure-Samples/cognitive-services-REST-api-samples

Tất cả issue của Azure-Samples/cognitive-services-REST-api-samples

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.