# Zingg-0.5.0

## Zingg-0.5.0

- [Welcome To Zingg](https://docs.zingg.ai/0.5.0/readme.md): Hope you find us useful :-)
- [Step-By-Step Guide](https://docs.zingg.ai/0.5.0/stepbystep.md): Instructions on how to install and use Zingg
- [Installation](https://docs.zingg.ai/0.5.0/stepbystep/installation.md): From the pre-built release hosted on GitHub
- [Docker](https://docs.zingg.ai/0.5.0/stepbystep/installation/docker.md): From pre-built Docker image with all dependencies included
- [Sharing Custom Data And Config Files](https://docs.zingg.ai/0.5.0/stepbystep/installation/docker/sharing-custom-data-and-config-files.md): Using custom data to save data files on host machine
- [Shared Locations](https://docs.zingg.ai/0.5.0/stepbystep/installation/docker/shared-locations.md): Shared location used to store Zingg configurations
- [File Read/Write Permissions](https://docs.zingg.ai/0.5.0/stepbystep/installation/docker/file-read-write-permissions.md): To enable user to have create/read/write files in shared location
- [Copying Files To And From The Container](https://docs.zingg.ai/0.5.0/stepbystep/installation/docker/copying-files-to-and-from-the-container.md): Alternative to volume/bind mount
- [Installing From Release](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-from-release.md): From the pre-built release hosted on GitHub
- [Single Machine Setup](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-from-release/single-machine-setup.md): For standalone local Spark without a cluster
- [Spark Cluster Checklist](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-from-release/spark-cluster-checklist.md): To configure Zingg in a Spark cluster
- [Installing Zingg](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-from-release/installing-zingg.md): Downloading and setting things up
- [Verifying The Installation](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-from-release/verification.md): To verify the Zingg installation works fine
- [Enterprise Installation for Snowflake](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake.md): From the jars provided
- [Setting up Zingg](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake/setting-up-zingg-enterprise-for-snowflake.md)
- [Snowflake Properties](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake/snowflake-properties.md): Connection Details
- [Match Configuration](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake/match-configuration.md): Configuring Zingg Enteprrise For Snowflake
- [Running Asynchronously](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake/running-asynchronously.md)
- [Verifying The Installation](https://docs.zingg.ai/0.5.0/stepbystep/installation/installing-zingg-enterprise-snowflake/verifying-the-installation.md)
- [Compiling From Source](https://docs.zingg.ai/0.5.0/stepbystep/installation/compiling-from-source.md): For a different Spark version or compiling latest code
- [Hardware Sizing](https://docs.zingg.ai/0.5.0/stepbystep/hardwaresizing.md): Hardware required for different sizes of data
- [Zingg Runtime Properties](https://docs.zingg.ai/0.5.0/stepbystep/zingg-runtime-properties.md): Memory, external jars and other runtime properties
- [Zingg Command Line](https://docs.zingg.ai/0.5.0/stepbystep/zingg-command-line.md): Using Zingg command line to interact with Zingg
- [Configuration](https://docs.zingg.ai/0.5.0/stepbystep/configuration.md): JSON configuration file required to work with Zingg
- [Configuring Through Environment Variables](https://docs.zingg.ai/0.5.0/stepbystep/configuration/configuring-through-environment-variables.md): Passing Configuration value through the system environment variable
- [Data Input And Output](https://docs.zingg.ai/0.5.0/stepbystep/configuration/data-input-and-output.md): Connecting Zingg to user data and writing results to a datastore and format of your choice
- [Input Data](https://docs.zingg.ai/0.5.0/stepbystep/configuration/data-input-and-output/data.md)
- [Output](https://docs.zingg.ai/0.5.0/stepbystep/configuration/data-input-and-output/output.md): Information about output generated
- [Field Definitions](https://docs.zingg.ai/0.5.0/stepbystep/configuration/field-definitions.md): Defining which fields should appear in the output and whether and how they need to be used in matching
- [Advanced Match Types](https://docs.zingg.ai/0.5.0/stepbystep/configuration/adv-matchtypes.md): Defining match types to support generic mappings as well as get domain knowledge
- [Deterministic Matching](https://docs.zingg.ai/0.5.0/stepbystep/configuration/deterministicmatching.md): Ensuring higher matching accuracy and performance
- [Pass Thru Data](https://docs.zingg.ai/0.5.0/stepbystep/configuration/passthru.md)
- [Model Location](https://docs.zingg.ai/0.5.0/stepbystep/configuration/model-location.md)
- [Tuning Label, Match And Link Jobs](https://docs.zingg.ai/0.5.0/stepbystep/configuration/tuning-label-match-and-link-jobs.md)
- [Telemetry](https://docs.zingg.ai/0.5.0/stepbystep/configuration/telemetry.md): Product usage data captured by Zingg OSS to improve user experience
- [Working With Training Data](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata.md)
- [Finding Records For Training Set Creation](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/findtrainingdata.md): Pairs of records that match or dont so as to train Zingg
- [Labeling Records](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/label.md): Providing user feedback on the training pairs
- [Find And Label](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/findandlabel.md)
- [Using Pre-existing Training Data](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/addowntrainingdata.md): Supplementing Zingg With Existing Training Data
- [Updating Labeled Pairs](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/updatinglabels.md)
- [Exporting Labeled Data](https://docs.zingg.ai/0.5.0/stepbystep/createtrainingdata/exportlabeleddata.md)
- [Verification of Blocking Model](https://docs.zingg.ai/0.5.0/stepbystep/verifyblocking.md): Understanding how blocking is working before running match or link
- [Building And Saving The Model](https://docs.zingg.ai/0.5.0/stepbystep/train.md): So that the same model can be applied to new data
- [Finding The Matches](https://docs.zingg.ai/0.5.0/stepbystep/match.md): Finds the records that match with each other.
- [Adding Incremental Data](https://docs.zingg.ai/0.5.0/stepbystep/runincremental.md): Building a continuously updated identity graph with new, updated, and deleted records
- [Linking Across Datasets](https://docs.zingg.ai/0.5.0/stepbystep/link.md)
- [Explanation of Models](https://docs.zingg.ai/0.5.0/stepbystep/modelexplain.md): To get a better understanding of how the data is trained and matched
- [Approval of Clusters](https://docs.zingg.ai/0.5.0/stepbystep/approval.md)
- [Combining Different Match Models](https://docs.zingg.ai/0.5.0/stepbystep/relations.md): When a single match model is not sufficient
- [Data Sources and Sinks](https://docs.zingg.ai/0.5.0/connectors.md)
- [Zingg Pipes](https://docs.zingg.ai/0.5.0/connectors/pipes.md)
- [Databricks](https://docs.zingg.ai/0.5.0/connectors/databricks.md)
- [Snowflake](https://docs.zingg.ai/0.5.0/connectors/snowflake.md): Identity Resolution on Snowflake
- [JDBC](https://docs.zingg.ai/0.5.0/connectors/jdbc.md)
- [Postgres](https://docs.zingg.ai/0.5.0/connectors/jdbc/postgres.md)
- [MySQL](https://docs.zingg.ai/0.5.0/connectors/jdbc/mysql.md)
- [AWS S3](https://docs.zingg.ai/0.5.0/connectors/amazons3.md)
- [Cassandra](https://docs.zingg.ai/0.5.0/connectors/cassandra.md)
- [MongoDB](https://docs.zingg.ai/0.5.0/connectors/mongodb.md)
- [Neo4j](https://docs.zingg.ai/0.5.0/connectors/neo4j.md)
- [Parquet](https://docs.zingg.ai/0.5.0/connectors/parquet.md)
- [BigQuery](https://docs.zingg.ai/0.5.0/connectors/bigquery.md)
- [Exasol](https://docs.zingg.ai/0.5.0/connectors/exasol.md)
- [Working With Python](https://docs.zingg.ai/0.5.0/working-with-python.md): A whole new way to work with Zingg!
- [Python API](https://docs.zingg.ai/0.5.0/working-with-python/index.md)
- [Running Zingg On Cloud](https://docs.zingg.ai/0.5.0/running.md)
- [Running On AWS](https://docs.zingg.ai/0.5.0/running/aws.md)
- [Running On Azure](https://docs.zingg.ai/0.5.0/running/azure.md)
- [Running On Databricks](https://docs.zingg.ai/0.5.0/running/databricks.md): Step by Step Identity Resolution with Zingg on Databricks
- [Running on Fabric](https://docs.zingg.ai/0.5.0/running/running-on-fabric.md): Step by Step Identity Resolution with Zingg on Fabric
- [Zingg Models](https://docs.zingg.ai/0.5.0/zmodels.md)
- [Pre-Trained Models](https://docs.zingg.ai/0.5.0/zmodels/pretrainedmodels.md)
- [Improving Accuracy](https://docs.zingg.ai/0.5.0/improving-accuracy.md)
- [Ignoring Commonly Occuring Words While Matching](https://docs.zingg.ai/0.5.0/improving-accuracy/stopwordsremoval.md)
- [Defining Domain Specific Blocking And Similarity Functions](https://docs.zingg.ai/0.5.0/improving-accuracy/definingown.md): To add blocking functions and how they work
- [Documenting The Model](https://docs.zingg.ai/0.5.0/generatingdocumentation.md)
- [Interpreting Output Scores](https://docs.zingg.ai/0.5.0/scoring.md)
- [Reporting Bugs And Contributing](https://docs.zingg.ai/0.5.0/contributing.md)
- [Setting Up Zingg Development Environment](https://docs.zingg.ai/0.5.0/contributing/settingupzingg.md)
- [Community](https://docs.zingg.ai/0.5.0/community.md)
- [Frequently Asked Questions](https://docs.zingg.ai/0.5.0/faq.md)
- [Reading Material](https://docs.zingg.ai/0.5.0/reading.md)
- [Security And Privacy](https://docs.zingg.ai/0.5.0/security.md): A note about telemetry and product usage data collection in Zingg


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.zingg.ai/0.5.0/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.