KnowledgebaseOperations Класс

  • Ссылка

Операции базы знаний.

Наследование
builtins.object
KnowledgebaseOperations

Конструктор

KnowledgebaseOperations(client, config, serializer, deserializer)

Параметры

Имя Описание
client
Обязательно

Клиент для запросов на обслуживание.
config
Обязательно

Настройка клиента службы.
serializer
Обязательно

Сериализатор объектной модели.
deserializer
Обязательно

Десериализатор объектной модели.

Методы

create

Асинхронная операция создания новой базы знаний.
delete

Удаляет базу знаний и все ее данные.
download

Скачивание базы знаний.
generate_answer

Вызов GenerateAnswer для запроса базы знаний (управляемый QnA Maker).
get_details

Возвращает сведения о конкретной базе знаний.
list_all

Возвращает все базы знаний для пользователя.
publish

Публикует все изменения в индексе тестирования базы знаний в индексе Prod.
replace

Замена содержимого базы знаний.
train

Вызов обучения для добавления предложений в базу знаний (управляемый QnAMaker).
update

Асинхронная операция изменения базы знаний.

create

Асинхронная операция создания новой базы знаний.

create(create_kb_payload, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
create_kb_payload
Обязательно
CreateKbDTO

Публикация текста запроса.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

delete

Удаляет базу знаний и все ее данные.

delete(kb_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

download

Скачивание базы знаний.

download(kb_id, environment, source=None, changed_since=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
environment
Обязательно
str или EnvironmentType

Указывает, является ли среда Test или Prod. Возможные значения: "Prod", "Test"
source
str

Фильтр свойств источника, который требуется применить.

значение по умолчанию: None
changed_since
str

Примененный фильтр свойств последнего изменения состояния.

значение по умолчанию: None
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
QnADocumentsDTO,
<xref:msrest.pipeline.ClientRawResponse>

QnADocumentsDTO или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

generate_answer

Вызов GenerateAnswer для запроса базы знаний (управляемый QnA Maker).

generate_answer(kb_id, generate_answer_payload, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
generate_answer_payload
Обязательно
QueryDTO

Публикация текста запроса.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
QnASearchResultList,
<xref:msrest.pipeline.ClientRawResponse>

QnASearchResultList или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

get_details

Возвращает сведения о конкретной базе знаний.

get_details(kb_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
KnowledgebaseDTO,
<xref:msrest.pipeline.ClientRawResponse>

База знанийDTO или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

list_all

Возвращает все базы знаний для пользователя.

list_all(custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
KnowledgebasesDTO,
<xref:msrest.pipeline.ClientRawResponse>

Базы знанийDTO или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

publish

Публикует все изменения в индексе тестирования базы знаний в индексе Prod.

publish(kb_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

replace

Замена содержимого базы знаний.

replace(kb_id, qn_alist, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
qn_alist
Обязательно
list[QnADTO]

Список Q-A (QnADTO), добавляемых в базу знаний. Идентификаторы Q-A назначаются службой и должны быть опущены.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

train

Вызов обучения для добавления предложений в базу знаний (управляемый QnAMaker).

train(kb_id, feedback_records=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
feedback_records
list[FeedbackRecordDTO]

Список записей отзывов.

значение по умолчанию: None
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

update

Асинхронная операция изменения базы знаний.

update(kb_id, update_kb, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
kb_id
Обязательно
str

Идентификатор базы знаний.
update_kb
Обязательно
UpdateKbOperationDTO

Публикация текста запроса.
custom_headers
dict

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw
bool

возвращает прямой ответ вместе с десериализованным ответом.

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
Operation,
<xref:msrest.pipeline.ClientRawResponse>

Operation или ClientRawResponse, если raw=true

Исключения

Тип Описание
ErrorResponseException

Атрибуты

models 

models = <module 'azure.cognitiveservices.knowledge.qnamaker.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\knowledge\\qnamaker\\models\\__init__.py'>