Skip to content

Postgres API

This documentation provides an overview of our Postgres API, your interface to connect the AIRefinery SDK to your Postgres databases.

Class Overview PostgresAPI

The PostgresAPI class provides an interface to connect you local postgres Database with the for an easy interaction between AIRefinery's SDK and your data. The PostgresAPI allows you also to log your interaction with the SDK locally with just few lines of code when added to DistillerClient method query().

Example: 

db_config = {
    "host": os.environ["DB_HOST"],
    "port": os.environ["DB_PORT"],
    "database": os.environ["DB_NAME"],
    "user": os.environ["DB_USER"],
    "password": os.environ["DB_PASSWORD"],
}
db_client = PostgresAPI(db_config)

async with distiller_client(
            project=project_name,
            uuid=uuid
    ) as dc:
        #Enables chat log
        responses = await dc.query(query=user_query, db_client=db_client)

Methods

__init__

Initialize the PostgresAPI object with database configuration settings.

def __init__(self, db_config: dict) -> None:
    ...

execute_query

Execute a SQL query using an asynchronous PostgreSQL connection.

async def execute_query(self, query: str, params: Optional[Any] = None) -> tuple[Optional[list[Any]], bool]:
Parameters:
  • query (str): The SQL query to execute.
  • params (Any, optional): The parameters to substitute into the query. Defaults to None.
Returns:
  • tuple[Optional[list[Any]], bool]: If successful, returns (query_results, True), where query_results is a list of results.