AlterationsOperations Class

  • Reference

AlterationsOperations operations.

Inheritance
builtins.object
AlterationsOperations

Constructor

AlterationsOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Methods

get

Download alterations from runtime.
get_alterations_for_kb

Download alterations per Knowledgebase (QnAMaker Managed).
replace

Replace alterations data.
replace_alterations_for_kb

Replace alterations data per Knowledgebase (QnAMaker Managed).

get

Download alterations from runtime.

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

Parameters

Name Description
custom_headers
dict

headers that will be added to the request

Default value: None
raw
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
WordAlterationsDTO,
<xref:msrest.pipeline.ClientRawResponse>

WordAlterationsDTO or ClientRawResponse if raw=true

Exceptions

Type Description
ErrorResponseException

get_alterations_for_kb

Download alterations per Knowledgebase (QnAMaker Managed).

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

Parameters

Name Description
kb_id
Required
str

Knowledgebase id.
custom_headers
dict

headers that will be added to the request

Default value: None
raw
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
WordAlterationsDTO,
<xref:msrest.pipeline.ClientRawResponse>

WordAlterationsDTO or ClientRawResponse if raw=true

Exceptions

Type Description
ErrorResponseException

replace

Replace alterations data.

replace(word_alterations, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
word_alterations
Required
list[AlterationsDTO]

Collection of word alterations.
custom_headers
dict

headers that will be added to the request

Default value: None
raw
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
None,
<xref:msrest.pipeline.ClientRawResponse>

None or ClientRawResponse if raw=true

Exceptions

Type Description
ErrorResponseException

replace_alterations_for_kb

Replace alterations data per Knowledgebase (QnAMaker Managed).

replace_alterations_for_kb(kb_id, word_alterations, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
kb_id
Required
str

Knowledgebase id.
word_alterations
Required
list[AlterationsDTO]

Collection of word alterations.
custom_headers
dict

headers that will be added to the request

Default value: None
raw
bool

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
None,
<xref:msrest.pipeline.ClientRawResponse>

None or ClientRawResponse if raw=true

Exceptions

Type Description
ErrorResponseException

Attributes

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'>