ExamplesOperations Class

ExamplesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Inheritance

builtins.object

ExamplesOperations

Constructor

ExamplesOperations(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

add	Adds a labeled example utterance in a version of the application.
batch	Adds a batch of labeled example utterances to a version of the application.
delete	Deletes the labeled example utterances with the specified ID from a version of the application.
list	Returns example utterances to be reviewed from a version of the application.

add

Adds a labeled example utterance in a version of the application.

add(app_id, version_id, example_label_object, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
example_label_object Required	ExampleLabelObject A labeled example utterance with the expected intent and entities.
enable_nested_children	bool Toggles nested/flat format Default value: False
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
LabelExampleResponse, <xref:msrest.pipeline.ClientRawResponse>	LabelExampleResponse or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

batch

Adds a batch of labeled example utterances to a version of the application.

batch(app_id, version_id, example_label_object_array, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
example_label_object_array Required	list[ExampleLabelObject] Array of example utterances.
enable_nested_children	bool Toggles nested/flat format Default value: False
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
list[BatchLabelExample], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

delete

Deletes the labeled example utterances with the specified ID from a version of the application.

delete(app_id, version_id, example_id, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
example_id Required	int The example 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
OperationStatus, <xref:msrest.pipeline.ClientRawResponse>	OperationStatus or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

list

Returns example utterances to be reviewed from a version of the application.

list(app_id, version_id, skip=0, take=100, enable_nested_children=False, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
app_id Required	str The application ID.
version_id Required	str The version ID.
skip	int The number of entries to skip. Default value is 0. Default value: 0
take	int The number of entries to return. Maximum page size is 500. Default is 100. Default value: 100
enable_nested_children	bool Toggles nested/flat format Default value: False
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
list[LabeledUtterance], <xref:msrest.pipeline.ClientRawResponse>	list or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

Attributes

models

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