Configuration

The PerseusClient utilizes Pydantic's BaseSettings for its configuration, allowing for flexible parameter management. Settings are loaded in a specific order of precedence:

Variables: Values set directly in the environment take the highest precedence (e.g., export PERSEUS_API_KEY="your_key").
File: A .env file located in the project root (where the SDK is run) will be loaded. This is a convenient way to manage local development settings without committing them to version control.
Default values: If a setting is not found in environment variables or a .env file, the SDK will use its predefined default values.

Here are the available configuration parameters:

Parameter	Type	Default Value	Description
`PERSEUS_API_KEY`	`str`	(required)	Your Perseus API key for authentication.
`NEO4J_URI`	`str`	`bolt://localhost:7687`	The URI for your Neo4j database connection.
`NEO4J_USER`	`str`	`neo4j`	The username for authenticating with Neo4j.
`NEO4J_PASSWORD`	`str`	`password`	The password for authenticating with Neo4j.
`FALKORDB_HOST`	`str`	`localhost`	The host for your FalkorDB database connection.
`FALKORDB_PORT`	`str`	`6379`	The port for your FalkorDB database connection.
`FALKORDB_USERNAME`	`str`	`None`	The username for authenticating with FalkorDB.
`FALKORDB_PASSWORD`	`str`	`None`	The password for authenticating with FalkorDB.
`FALKORDB_GRAPH_NAME`	`str`	`perseus_graph`	The graph name for your FalkorDB database.
`LOGLEVEL`	`str`	`INFO`	The logging level for the SDK (e.g., `DEBUG`, `INFO`, `WARNING`, `ERROR`).