weaviate.classification package

Module for classifying objects within Weaviate.

class weaviate.classification.Classification(connection: Connection)[source]

Bases: object

Classification class used to schedule and/or check the status of a classification process of Weaviate objects.

Initialize a Classification class instance.

Parameters

connectionweaviate.connect.Connection

Connection object to an active and running Weaviate instance.

get(classification_uuid: str) dict[source]

Polls the current state of the given classification.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

dict

A dict containing the Weaviate answer.

Raises

ValueError

If not a proper uuid.

requests.ConnectionError

If the network connection to weaviate fails.

weaviate.UnexpectedStatusCodeException

If weaviate reports a none OK status.

is_complete(classification_uuid: str) bool[source]

Checks if a started classification job has completed.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if given classification has finished, False otherwise.

is_failed(classification_uuid: str) bool[source]

Checks if a started classification job has failed.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if the classification failed, False otherwise.

is_running(classification_uuid: str) bool[source]

Checks if a started classification job is running.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if the classification is running, False otherwise.

schedule() ConfigBuilder[source]

Schedule a Classification of the Objects within Weaviate.

Returns

weaviate.classification.config_builder.ConfigBuilder

A ConfigBuilder that should be configured to the desired classification task

class weaviate.classification.ConfigBuilder(connection: Connection, classification: Classification)[source]

Bases: object

ConfigBuild class that is used to configure a classification process.

Initialize a ConfigBuilder class instance.

Parameters

connectionweaviate.connect.Connection

Connection object to an active and running weaviate instance.

classificationweaviate.classification.Classification

Classification object to be configured using this ConfigBuilder instance.

do() dict[source]

Start the classification.

Returns

dict

Classification result.

with_based_on_properties(based_on_properties: list) ConfigBuilder[source]

Set properties to build the classification on.

Parameters

based_on_properties: list

A list of properties to classify on.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_class_name(class_name: str) ConfigBuilder[source]

What Object type to classify.

Parameters

class_namestr

Name of the class to be classified.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_classify_properties(classify_properties: list) ConfigBuilder[source]

Set the classify properties.

Parameters

classify_properties: list

A list of properties to classify.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_k(k: int) ConfigBuilder[source]

Set k number for the kNN.

Parameters

kint

Number of objects to use to make a classification guess. (For kNN)

Returns

ConfigBuilder

Updated ConfigBuilder.

with_settings(settings: dict) ConfigBuilder[source]

Set settings for the classification. NOTE if you are using ‘kNN’ the value ‘k’ can be set by this method or by ‘with_k’. This method keeps previously set ‘settings’.

Parameters

settings: dict

Additional settings to be set/overwritten.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_source_where_filter(where_filter: dict) ConfigBuilder[source]

Set Source ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_target_where_filter(where_filter: dict) ConfigBuilder[source]

Set Target ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_training_set_where_filter(where_filter: dict) ConfigBuilder[source]

Set Training set ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_type(classification_type: str) ConfigBuilder[source]

Set classification type.

Parameters

classification_typestr

Type of the desired classification.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_wait_for_completion() ConfigBuilder[source]

Wait for completion.

Returns

ConfigBuilder

Updated ConfigBuilder.

Submodules

weaviate.classification.classification module

Classification class definition.

class weaviate.classification.classification.Classification(connection: Connection)[source]

Bases: object

Classification class used to schedule and/or check the status of a classification process of Weaviate objects.

Initialize a Classification class instance.

Parameters

connectionweaviate.connect.Connection

Connection object to an active and running Weaviate instance.

get(classification_uuid: str) dict[source]

Polls the current state of the given classification.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

dict

A dict containing the Weaviate answer.

Raises

ValueError

If not a proper uuid.

requests.ConnectionError

If the network connection to weaviate fails.

weaviate.UnexpectedStatusCodeException

If weaviate reports a none OK status.

is_complete(classification_uuid: str) bool[source]

Checks if a started classification job has completed.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if given classification has finished, False otherwise.

is_failed(classification_uuid: str) bool[source]

Checks if a started classification job has failed.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if the classification failed, False otherwise.

is_running(classification_uuid: str) bool[source]

Checks if a started classification job is running.

Parameters

classification_uuidstr

Identifier of the classification.

Returns

bool

True if the classification is running, False otherwise.

schedule() ConfigBuilder[source]

Schedule a Classification of the Objects within Weaviate.

Returns

weaviate.classification.config_builder.ConfigBuilder

A ConfigBuilder that should be configured to the desired classification task

weaviate.classification.config_builder module

ConfigBuilder class definition.

class weaviate.classification.config_builder.ConfigBuilder(connection: Connection, classification: Classification)[source]

Bases: object

ConfigBuild class that is used to configure a classification process.

Initialize a ConfigBuilder class instance.

Parameters

connectionweaviate.connect.Connection

Connection object to an active and running weaviate instance.

classificationweaviate.classification.Classification

Classification object to be configured using this ConfigBuilder instance.

do() dict[source]

Start the classification.

Returns

dict

Classification result.

with_based_on_properties(based_on_properties: list) ConfigBuilder[source]

Set properties to build the classification on.

Parameters

based_on_properties: list

A list of properties to classify on.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_class_name(class_name: str) ConfigBuilder[source]

What Object type to classify.

Parameters

class_namestr

Name of the class to be classified.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_classify_properties(classify_properties: list) ConfigBuilder[source]

Set the classify properties.

Parameters

classify_properties: list

A list of properties to classify.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_k(k: int) ConfigBuilder[source]

Set k number for the kNN.

Parameters

kint

Number of objects to use to make a classification guess. (For kNN)

Returns

ConfigBuilder

Updated ConfigBuilder.

with_settings(settings: dict) ConfigBuilder[source]

Set settings for the classification. NOTE if you are using ‘kNN’ the value ‘k’ can be set by this method or by ‘with_k’. This method keeps previously set ‘settings’.

Parameters

settings: dict

Additional settings to be set/overwritten.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_source_where_filter(where_filter: dict) ConfigBuilder[source]

Set Source ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_target_where_filter(where_filter: dict) ConfigBuilder[source]

Set Target ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_training_set_where_filter(where_filter: dict) ConfigBuilder[source]

Set Training set ‘where’ Filter.

Parameters

where_filterdict

Filter to use, as a dict.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_type(classification_type: str) ConfigBuilder[source]

Set classification type.

Parameters

classification_typestr

Type of the desired classification.

Returns

ConfigBuilder

Updated ConfigBuilder.

with_wait_for_completion() ConfigBuilder[source]

Wait for completion.

Returns

ConfigBuilder

Updated ConfigBuilder.