PyGEAI is a Python Software Development Kit (SDK) for interacting with Globant Enterprise AI. It comprises libraries, tools, code samples, and documentation to simplify your experience with the platform.
Before using the SDK, you need to define GEAI_API_KEY ($SAIA_APITOKEN) and GEAI_API_BASE_URL ($BASE_URL). You can achieve this in three ways:
- Environment variables: Set GEAI_API_KEY and GEAI_API_BASE_URL as environment variables in your operating system.
- Credentials file: Create a file named credentials in the .geai directory within your user home directory ($USER_HOME/.geai/credentials) and define GEAI_API_KEY and GEAI_API_BASE_URL within this file.
- Client instantiation: Specify the api_key and base_url parameters directly when creating an instance of a client class.
Note: If you plan to use the Evaluation Module, you must also define GEAI_API_EVAL_URL.
The SDK consists of several modules, all accessible through a meta-package:
- pygeai: This meta-package encapsulates all components of the SDK.
- pygeai-cli: This package provides a command-line tool for interacting with the SDK.
- pygeai-chat: This package offers facilities to chat with assistants/agents created in Globant Enterprise AI.
- pygeai-dbg: This package includes a debugger to troubleshoot potential SDK issues and gain detailed insights into its operations. This is currently under development.
- pygeai-core: This package handles interactions with the fundamental components of Globant Enterprise AI, including users, groups, permissions, API keys, organizations, and Projects.
- pygeai-admin: This package enables interactions with the Globant Enterprise AI instance.
- pygeai-lab: This package facilitates interactions with Globant Enterprise AI Lab.
- pygeai-evaluation: This package provides functionality from the Evaluation module.
- pygeai-gam: This package allows interaction with GAM.
- pygeai-assistant: This package handles interactions with various Assistants, including Data Analyst Assistants, RAG Assistants, Chat with Data Assistants, and Chat Assistants.
- pygeai-organization: This package facilitates interactions with Organizations in Globant Enterprise AI.
- pygeai-flows: This package enables interactions with Flows. This is currently under development.
Use pip to install the package from PyPI:
(venv) ~$ pip install pygeai
To check the installed PyGEAI version, run:
(venv) ~$ geai v
To access the general help menu:
(venv) ~$ geai h
To view help for a specific command:
(venv) ~$ geai h
Since May 2025 release.