Trait SzEngine

pub trait SzEngine {
    // Required methods
    fn prime_engine(&self) -> SzResult<()>;
    fn get_stats(&self) -> SzResult<JsonString>;
    fn add_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        record_definition: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_record_preview(
        &self,
        record_definition: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn delete_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn reevaluate_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn reevaluate_entity(
        &self,
        entity_id: EntityId,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn search_by_attributes(
        &self,
        attributes: &str,
        search_profile: Option<&str>,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn why_search(
        &self,
        attributes: &str,
        entity_id: EntityId,
        search_profile: Option<&str>,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_entity(
        &self,
        entity_id: EntityId,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_entity_by_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn find_interesting_entities_by_entity_id(
        &self,
        entity_id: EntityId,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn find_interesting_entities_by_record(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn find_path(
        &self,
        start_entity_id: EntityId,
        end_entity_id: EntityId,
        max_degrees: i64,
        avoid_entity_ids: Option<&HashSet<EntityId>>,
        required_data_sources: Option<&HashSet<String>>,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn find_network(
        &self,
        entity_list: &[EntityId],
        max_degrees: i64,
        build_out_degree: i64,
        max_entities: i64,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn why_entity(
        &self,
        entity_id1: EntityId,
        entity_id2: EntityId,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn why_records(
        &self,
        data_source_code1: &str,
        record_id1: &str,
        data_source_code2: &str,
        record_id2: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn why_record_in_entity(
        &self,
        data_source_code: &str,
        record_id: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn how_entity(
        &self,
        entity_id: EntityId,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_virtual_entity(
        &self,
        record_keys: &[(String, String)],
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn process_redo_record(
        &self,
        redo_record: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<JsonString>;
    fn get_redo_record(&self) -> SzResult<JsonString>;
    fn count_redo_records(&self) -> SzResult<i64>;
    fn export_json_entity_report(
        &self,
        flags: Option<SzFlags>,
    ) -> SzResult<ExportHandle>;
    fn export_csv_entity_report(
        &self,
        csv_column_list: &str,
        flags: Option<SzFlags>,
    ) -> SzResult<ExportHandle>;
    fn fetch_next(&self, export_handle: ExportHandle) -> SzResult<JsonString>;
    fn close_export(&self, export_handle: ExportHandle) -> SzResult<()>;
}

Core entity resolution engine operations

The SzEngine trait provides methods for adding records, retrieving entities, performing searches, and conducting various types of analysis.

Required Methods

fn prime_engine(&self) -> SzResult<()>

Primes the engine for optimal performance

fn get_stats(&self) -> SzResult<JsonString>

Gets engine statistics

fn add_record( &self, data_source_code: &str, record_id: &str, record_definition: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Adds a record for entity resolution

fn get_record_preview( &self, record_definition: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Gets a preview of how a record would be processed

fn delete_record( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Deletes a record from the entity repository

fn reevaluate_record( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Reevaluates a specific record

fn reevaluate_entity( &self, entity_id: EntityId, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Reevaluates all records for a specific entity

fn search_by_attributes( &self, attributes: &str, search_profile: Option<&str>, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Searches for entities by attributes

fn why_search( &self, attributes: &str, entity_id: EntityId, search_profile: Option<&str>, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Analyzes why a search result was returned for an entity

fn get_entity( &self, entity_id: EntityId, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Gets entity information by entity ID

fn get_entity_by_record( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Gets entity information by record identifier

fn get_record( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Gets record information

fn find_interesting_entities_by_entity_id( &self, entity_id: EntityId, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Finds interesting entities related to a given entity

fn find_interesting_entities_by_record( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Finds interesting entities related to a given record

fn find_path( &self, start_entity_id: EntityId, end_entity_id: EntityId, max_degrees: i64, avoid_entity_ids: Option<&HashSet<EntityId>>, required_data_sources: Option<&HashSet<String>>, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Finds a path between two entities

fn find_network( &self, entity_list: &[EntityId], max_degrees: i64, build_out_degree: i64, max_entities: i64, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Finds a network of entities

fn why_entity( &self, entity_id1: EntityId, entity_id2: EntityId, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Analyzes why two entities resolved together

fn why_records( &self, data_source_code1: &str, record_id1: &str, data_source_code2: &str, record_id2: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Analyzes why two records resolved together

fn why_record_in_entity( &self, data_source_code: &str, record_id: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Analyzes why a record is in an entity

fn how_entity( &self, entity_id: EntityId, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Analyzes how an entity was resolved

fn get_virtual_entity( &self, record_keys: &[(String, String)], flags: Option<SzFlags>, ) -> SzResult<JsonString>

Gets a virtual entity based on record definitions

fn process_redo_record( &self, redo_record: &str, flags: Option<SzFlags>, ) -> SzResult<JsonString>

Processes a redo record

fn get_redo_record(&self) -> SzResult<JsonString>

Gets the next redo record

fn count_redo_records(&self) -> SzResult<i64>

Counts the number of redo records

fn export_json_entity_report( &self, flags: Option<SzFlags>, ) -> SzResult<ExportHandle>

Exports entity data

fn export_csv_entity_report( &self, csv_column_list: &str, flags: Option<SzFlags>, ) -> SzResult<ExportHandle>

Exports CSV entity report

fn fetch_next(&self, export_handle: ExportHandle) -> SzResult<JsonString>

Fetches the next batch of export data

fn close_export(&self, export_handle: ExportHandle) -> SzResult<()>

Closes an export operation

Implementors

impl SzEngine for SzEngineCore