Senzing®

Senzing Documentation

  • Release Information
    • v4 Release
      • v4 What's New
      • v4 System Requirements
      • v4 Breaking Changes
        • v4 Hardware and Software Changes
        • v4 SDK Breaking Changes
        • v4 Schema Changes
    • v3 Release
      • v3 Breaking Changes
  • Entity Specification
  • Globalization Guide
  • Quickstart Guides
    • v4 Linux Quickstart
    • v4 Docker Quickstart
    • v4 AWS Quickstart
    • v4 Azure Quickstart
    • v3 Quickstart Guides
      • v3 Linux Quickstart
      • v3 Docker Quickstart
      • v3 AWS Quickstart
      • v3 Azure Quickstart
  • C# SDK Reference
    • v4 C# SDK
  • Java SDK Reference
    • v4 Java SDK
    • v3 Java SDK
  • Python SDK Reference
    • v4 Python SDK
      • v4 in 3 Python Calls
    • v3 Python SDK
      • v3 in 3 Python Calls
      • v3 G2ConfigMgr
      • v3 G2Config
      • G2Engine
        • v3 Initialization
        • v3 Flags
        • v3 Adding Records
        • v3 Reevaluating
        • v3 Redo Processing
        • v3 Deleting Records
        • v3 Getting Entities and Records
        • v3 Searching for Entities
        • v3 Finding Paths
        • v3 Finding Networks
        • v3 Why
        • v3 How
        • v3 Reporting
        • v3 Cleanup
        • v3 Stats
  • Engine Flags
    • v4 Engine Flags
      • add_record Flags
      • delete_record Flags
      • get_record Flags
      • get_entity* Flags
      • search_by_attributes Flags
      • find_path* Flags
      • find_network* Flags
      • how_entity_by_entity_id Flags
      • get_virtual_entity_by_record_id Flags
    • v3 Engine Flags
  • Tutorials
    • Senzing Engine Configuration
    • EDA (Exploratory Data Analysis) Tools
      • Truth-Set Demo
      • Basic Exploration
    • Consuming "get_entity" Responses
    • Real-time Replication and Analytics
    • Database Setup
      • PostgreSQL Setup
      • MSSQL Setup
      • MySQL Setup
      • Database Tuning
    • Upgrade Schema and Config
      • Upgrade Schema to v4
      • Upgrade ER Config to v4
  1. Home
  2. Senzing Documentation
  3. Engine Flags
  4. v4 Engine Flags

v4 Engine Flags

Flags are optional parameters that specify what data about an entity, record, features, or relationships to retrieve. Each function’s relevant flags are detailed here. If no flag parameter is given then the default flags are used.

add_record Flags
Flags for the add_record function
delete_record Flags
Flags for the delete_record function
get_record Flags
Flags for the get_record function
get_entity_by_entity_id, get_entity_by_record_id Flags
Flags for entity retrieval functions
search_by_attributes Flags
Flags for the search_by_attributes function
find_path_by_entity_id, find_path_by_record_id Flags
Flags for path finding functions
find_network_by_entity_id, find_network_by_record_id Flags
Flags for network finding functions
how_entity_by_entity_id Flags
Flags for the how_entity_by_entity_id function
get_virtual_entity_by_record_id
Flags for the get_virtual_entity_by_record_id function
Contact Senzing Support
Senzing support is 100% FREE!

© 2026 Senzing Documentation. All rights reserved. SENZING® and SZ® are registered trademarks of Senzing, Inc. and may not be used without prior written permission. CONNECT DATA. POWER INTELLIGENCE.™, ENTITY CENTRIC LEARNING™, SENZING INSIDE™, and SMARTER ENTITY RESOLUTION™ are also trademarks of Senzing, Inc. and may also not be used without prior written permission.

Contact Senzing Support Senzing.com GitHub