Question Answering Projects - Import

Ссылка

Служба:: Cognitive Services - Language

Версия API:: 2023-04-01

Импорт ресурсов проекта.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

С использованием необязательных параметров:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия API клиента.
assetKind	query		string	Тип ресурса проекта.
format	query		format	Формат импорта или экспорта базы знаний.

Текст запроса

Имя	Тип	Описание
assets	Assets	Все ресурсы для этого проекта.
fileUri	string	Импорт URI файла данных.
metadata	CreateProjectOptions	Параметры, необходимые для создания проекта.

Ответы

Имя	Тип	Описание
202 Accepted		Ответ будет содержать заголовок Operation-Location, используемый для проверки состояния задания. Заголовки Operation-Location: string
Other Status Codes	ErrorResponse	Ответ об ошибке.

Имя

Тип

Описание

202 Accepted

Ответ будет содержать заголовок Operation-Location, используемый для проверки состояния задания.

Заголовки

Operation-Location: string

Other Status Codes

ErrorResponse

Ответ об ошибке.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful query

Образец запроса

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "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": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Пример ответа

Код состояния:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

Определения

Имя	Описание
Assets	Все ресурсы для этого проекта.
CreateProjectOptions	Параметры, необходимые для создания проекта.
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
format	Формат импорта или экспорта базы знаний.
ImportJobOptions	Ресурсы проекта необходимо импортировать.
ImportQnaRecord	Импорт записи QnA.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings	Настраиваемые параметры проекта.
QnaDialog	Диалоговое окно, связанное с записью QnA.
QnaPrompt	Запрос ответа.
QnaRecord	Запись QnA.
SuggestedQuestion	Вопрос, предложенный функцией активного обучения.
SuggestedQuestionsCluster	Сведения о кластере предлагаемых вопросов по активному обучению.
WordAlterations	Коллекция изменений слов.

Assets

Все ресурсы для этого проекта.

Имя	Тип	Описание
qnas	ImportQnaRecord[]	Список записей QnA для импорта.
synonyms	WordAlterations[]	Коллекция синонимов.

CreateProjectOptions

Параметры, необходимые для создания проекта.

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если значение не задано, используйте "en" для английского языка по умолчанию.
multilingualResource	boolean	Задайте значение true, чтобы разрешить создание баз знаний на разных языках для одного и того же ресурса.
settings	ProjectSettings	Настраиваемые параметры проекта.

Error

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Ответ об ошибке.

Имя	Тип	Описание
error	Error	Объект ошибки.

format

Формат импорта или экспорта базы знаний.

Имя	Тип	Описание
excel	string	Экспорт или импорт база знаний реплика, включая все ресурсы и метаданные в формате Tsv.
json	string	Экспорт или импорт ресурсов QnA в формате JSON.
tsv	string	Экспорт или импорт база знаний реплика включая все ресурсы и метаданные в формате Excel.

ImportJobOptions

Ресурсы проекта необходимо импортировать.

Имя	Тип	Описание
assets	Assets	Все ресурсы для этого проекта.
fileUri	string	Импорт URI файла данных.
metadata	CreateProjectOptions	Параметры, необходимые для создания проекта.

ImportQnaRecord

Импорт записи QnA.

Имя	Тип	Описание
activeLearningSuggestions	SuggestedQuestionsCluster[]	Список предложений по активному обучению для QnA.
answer	string	Текст ответа.
dialog	QnaDialog	Контекст QnA.
id	integer	Уникальный идентификатор для QnA.
lastUpdatedDateTime	string	Дата и время последнего обновления QnA.
metadata	object	Метаданные, связанные с ответом, полезны для классификации или фильтрации ответов на вопросы.
questions	string[]	Список вопросов, связанных с ответом.
source	string	Источник, из которого индексировался QnA, например https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName	string	Понятное имя источника.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
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

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из серверных наборов кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ProjectSettings

Настраиваемые параметры проекта.

Имя	Тип	Описание
defaultAnswer	string	Ответ по умолчанию, если в база знаний не найдено подходящего совпадения.

QnaDialog

Диалоговое окно, связанное с записью QnA.

Имя	Тип	Описание
isContextOnly	boolean	Чтобы пометить, является ли запрос актуальным только с предыдущим вопросом или нет. Если задано значение true, не следует включать этот вопрос в качестве ответа на запросы без контекста; в противном случае игнорирует контекст и включает этот вопрос в ответы.
prompts	QnaPrompt[]	Список запросов, связанных с ответом.

QnaPrompt

Запрос ответа.

Имя	Тип	Описание
displayOrder	integer	Индекс запроса. Он используется для упорядочения запросов.
displayText	string	Текст, отображаемый для представления запроса на последующий вопрос.
qna	QnaRecord	Запись QnA. В запросе должна присутствовать запись QnAId или QnA.
qnaId	integer	Идентификатор QnA, соответствующий запросу.

QnaRecord

Запись QnA.

Имя	Тип	Описание
activeLearningSuggestions	SuggestedQuestionsCluster[]	Список предложений по активному обучению для QnA.
answer	string	Текст ответа.
dialog	QnaDialog	Контекст QnA.
id	integer	Уникальный идентификатор для QnA.
metadata	object	Метаданные, связанные с ответом, полезны для классификации или фильтрации ответов на вопросы.
questions	string[]	Список вопросов, связанных с ответом.
source	string	Источник, из которого индексировался QnA, например https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Вопрос, предложенный функцией активного обучения.

Имя	Тип	Описание
autoSuggestedCount	integer	Количество автоматически задаваемых вопросов алгоритмом активного обучения.
question	string	Вопрос, предложенный функцией активного обучения.
userSuggestedCount	integer	Количество явно предложенных пользователем вопросов.

SuggestedQuestionsCluster

Сведения о кластере предлагаемых вопросов по активному обучению.

Имя	Тип	Описание
clusterHead	string	Вопрос, выбранный в качестве руководителя кластера предлагаемых вопросов по алгоритму Active Learning кластеризация.
suggestedQuestions	SuggestedQuestion[]	Список всех предлагаемых вопросов для QnA.

WordAlterations

Коллекция изменений слов.

Имя	Тип	Описание
alterations	string[]	Коллекция изменений слов.

Поделиться через

Question Answering Projects - Import

Параметры URI

Текст запроса

Ответы

Безопасность

AADToken

Примечания

Области

Ocp-Apim-Subscription-Key

Примеры

Successful query

Образец запроса

Пример ответа

Определения

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Дополнительные ресурсы