EntitiesMixin#

class EntitiesMixin#

Bases: object

Methods Summary

create_entities(project_id, entity_list)

Creates new entities.

delete_entities(project_id, entity_ids)

Deletes entities by entity ids.

get_entities(project_id, entity_ids)

Gets entities by entity ids.

get_entities_properties(project_id[, query])

Get entity types and corresponding properties of entity

modify_entities(project_id, entity_list)

Updates existing entities.

Methods Documentation

create_entities(project_id, entity_list)#

Creates new entities.

Parameters:

entity_list – [entity, …]

delete_entities(project_id, entity_ids)#

Deletes entities by entity ids.

Parameters:

entity_ids – List of IDs referring to entities

get_entities(project_id, entity_ids)#

Gets entities by entity ids.

Parameters:

entity_ids – List of IDs referring to entities

get_entities_properties(project_id, query=None)#

Get entity types and corresponding properties of entity

Parameters:
  • project_id – Identifier of project

  • query – Filtering query

Returns:

Dictionary of entity and corresponding properties of entity

Example:

{
    "career": ["properties.job,numeric_properties.salary"],
}
modify_entities(project_id, entity_list)#

Updates existing entities.

Parameters:

entity_list – [entity, …]