| Name | pygeai JSON |
| Version |
0.2.6
JSON |
| download |
| home_page | None |
| Summary | Software Development Kit to interact with Globant Enterprise AI. |
| upload_time | 2025-05-21 16:35:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
geai
pygeai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyGEAI - SDK for Globant Enterprise AI
PyGEAI is a Software Development Kit (SDK) for interacting with [Globant Enterprise AI](https://wiki.genexus.com/enterprise-ai/wiki?8,Table+of+contents%3AEnterprise+AI). It comprises libraries, tools, code samples, and documentation to simplify your experience with the platform.
## Repository
Find the PyGEAI source code and documentation in the following GitHub repository:
[GitHub repository](https://github.com/RT-GEN029-GI/pygeai)
## Configuration
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](https://wiki.genexus.com/enterprise-ai/wiki?896,Evaluation), you must also define `GEAI_API_EVAL_URL`
## Modules
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.
- **`pygeai-core`**: This package handles interactions with the fundamental components of Globant Enterprise AI, including users, groups, permissions, API keys, organizations, and [Projects](https://wiki.genexus.com/enterprise-ai/wiki?565,Projects).
- **`pygeai-admin`**: This package enables interactions with the Globant Enterprise AI instance.
- **`pygeai-lab`**: This package facilitates interactions with AI LAB.
- **`pygeai-evaluation`**: This package provides functionality from the evaluation module.
- **`pygeai-gam`**: This package allows interaction with [GAM] (https://wiki.genexus.com/commwiki/wiki?24746,Table+of+contents%3AGeneXus+Access+Manager+%28GAM%29,).
- **`pygeai-assistant`**: This package handles interactions with various Assistants, including [Data Analyst Assistants](https://wiki.genexus.com/enterprise-ai/wiki?886,Data+Analyst+Assistant+2.0), [RAG Assistants](https://wiki.genexus.com/enterprise-ai/wiki?44,RAG+Assistants+Introduction), [Chat with Data Assistants](https://wiki.genexus.com/enterprise-ai/wiki?159,Chat+with+Data+Assistant), [Chat with API Assistants](https://wiki.genexus.com/enterprise-ai/wiki?110,API+Assistant), and [Chat Assistants](https://wiki.genexus.com/enterprise-ai/wiki?708,Chat+Assistant).
- **`pygeai-organization`**: This package facilitates interactions with Organizations in Globant Enterprise AI.
- **`pygeai-flows`**: This package enables interactions with [Flows](https://wiki.genexus.com/enterprise-ai/wiki?321,Flows+in+Globant+Enterprise+AI) [in development].
## Usage
### Install PyGEAI
Use pip to install the package from PyPI:
```
(venv) ~$ pip install pygeai
```
To install pre-release versions, you can run:
```
(venv) ~$ pip install --pre pygeai
```
### Verify installation
To check the installed PyGEAI version, run:
```
(venv) ~$ geai v
```
### View help
To access the general help menu:
```
(venv) ~$ geai h
```
To view help for a specific command:
```
(venv) ~$ geai <command> h
```
### Debugger
The `pygeai-dbg` package provides a command-line debugger (`geai-dbg`) for troubleshooting and inspecting the `geai` CLI.
It pauses execution at breakpoints, allowing you to inspect variables, execute Python code, and control program flow interactively.
To debug a `geai` command, replace `geai` with `geai-dbg`. For example:
```bash
(venv) ~$ geai-dbg ail lrs
```
This pauses at the `main` function in `pygeai.cli.geai`, displaying an interactive prompt `(geai-dbg)`.
You can then use commands like `continue` (resume), `run` (run without pauses), `quit` (exit), or `help` (list commands).
### Man Pages Documentation
The package includes Unix manual pages (man pages) for detailed command-line documentation. To access the man pages:
```bash
man geai
```
#### Setting up Man Pages Access
If you're using a virtual environment, you'll need to configure your system to find the man pages. Add the following to your shell configuration file (`.bashrc`, `.zshrc`, etc.):
```bash
# For macOS
if [ -n "$VIRTUAL_ENV" ]; then
export MANPATH="$VIRTUAL_ENV/share/man:$MANPATH"
fi
# For Linux
if [ -n "$VIRTUAL_ENV" ]; then
export MANPATH="$VIRTUAL_ENV/man:$MANPATH"
fi
```
After adding this configuration:
1. Reload your shell configuration: `source ~/.bashrc` or `source ~/.zshrc`
2. The man pages will be available when your virtual environment is active
## Bugs and suggestions
To report any bug, request features or make any suggestions, the following email is available:
<geai-sdk@globant.com>
## Authors
Copyright 2025, Globant. All rights reserved
Raw data
{
"_id": null,
"home_page": null,
"name": "pygeai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "geai, pygeai",
"author": null,
"author_email": "Globant <geai-sdk@globant.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/8e/b3ad1dad3909df11d5a5fb5c51f44547af1780beaeb5faabfba00ddd0540/pygeai-0.2.6.tar.gz",
"platform": null,
"description": "# PyGEAI - SDK for Globant Enterprise AI\n\nPyGEAI is a Software Development Kit (SDK) for interacting with [Globant Enterprise AI](https://wiki.genexus.com/enterprise-ai/wiki?8,Table+of+contents%3AEnterprise+AI). It comprises libraries, tools, code samples, and documentation to simplify your experience with the platform.\n\n## Repository\n\nFind the PyGEAI source code and documentation in the following GitHub repository:\n\n[GitHub repository](https://github.com/RT-GEN029-GI/pygeai)\n\n## Configuration\n\nBefore 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:\n\n* **Environment variables:** Set `GEAI_API_KEY` and `GEAI_API_BASE_URL` as environment variables in your operating system.\n* **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.\n* **Client instantiation:** Specify the `api_key` and `base_url` parameters directly when creating an instance of a client class.\n\n**Note:** If you plan to use the [Evaluation Module](https://wiki.genexus.com/enterprise-ai/wiki?896,Evaluation), you must also define `GEAI_API_EVAL_URL`\n\n## Modules\n\nThe SDK consists of several modules, all accessible through a meta-package:\n\n- **`pygeai`**: This meta-package encapsulates all components of the SDK.\n- **`pygeai-cli`**: This package provides a command-line tool for interacting with the SDK.\n- **`pygeai-chat`**: This package offers facilities to chat with assistants/agents created in Globant Enterprise AI.\n- **`pygeai-dbg`**: This package includes a debugger to troubleshoot potential SDK issues and gain detailed insights into its operations.\n- **`pygeai-core`**: This package handles interactions with the fundamental components of Globant Enterprise AI, including users, groups, permissions, API keys, organizations, and [Projects](https://wiki.genexus.com/enterprise-ai/wiki?565,Projects).\n- **`pygeai-admin`**: This package enables interactions with the Globant Enterprise AI instance.\n- **`pygeai-lab`**: This package facilitates interactions with AI LAB.\n- **`pygeai-evaluation`**: This package provides functionality from the evaluation module.\n- **`pygeai-gam`**: This package allows interaction with [GAM] (https://wiki.genexus.com/commwiki/wiki?24746,Table+of+contents%3AGeneXus+Access+Manager+%28GAM%29,).\n- **`pygeai-assistant`**: This package handles interactions with various Assistants, including [Data Analyst Assistants](https://wiki.genexus.com/enterprise-ai/wiki?886,Data+Analyst+Assistant+2.0), [RAG Assistants](https://wiki.genexus.com/enterprise-ai/wiki?44,RAG+Assistants+Introduction), [Chat with Data Assistants](https://wiki.genexus.com/enterprise-ai/wiki?159,Chat+with+Data+Assistant), [Chat with API Assistants](https://wiki.genexus.com/enterprise-ai/wiki?110,API+Assistant), and [Chat Assistants](https://wiki.genexus.com/enterprise-ai/wiki?708,Chat+Assistant).\n- **`pygeai-organization`**: This package facilitates interactions with Organizations in Globant Enterprise AI.\n- **`pygeai-flows`**: This package enables interactions with [Flows](https://wiki.genexus.com/enterprise-ai/wiki?321,Flows+in+Globant+Enterprise+AI) [in development]. \n\n## Usage\n\n### Install PyGEAI\nUse pip to install the package from PyPI:\n\n```\n(venv) ~$ pip install pygeai\n```\n\nTo install pre-release versions, you can run:\n```\n(venv) ~$ pip install --pre pygeai\n```\n\n### Verify installation\nTo check the installed PyGEAI version, run:\n\n```\n(venv) ~$ geai v\n```\n\n### View help\n\nTo access the general help menu:\n\n```\n(venv) ~$ geai h\n```\nTo view help for a specific command:\n\n```\n(venv) ~$ geai <command> h\n```\n\n### Debugger\n\nThe `pygeai-dbg` package provides a command-line debugger (`geai-dbg`) for troubleshooting and inspecting the `geai` CLI. \nIt pauses execution at breakpoints, allowing you to inspect variables, execute Python code, and control program flow interactively.\n\nTo debug a `geai` command, replace `geai` with `geai-dbg`. For example:\n\n```bash\n(venv) ~$ geai-dbg ail lrs\n```\n\nThis pauses at the `main` function in `pygeai.cli.geai`, displaying an interactive prompt `(geai-dbg)`. \nYou can then use commands like `continue` (resume), `run` (run without pauses), `quit` (exit), or `help` (list commands).\n\n\n### Man Pages Documentation\n\nThe package includes Unix manual pages (man pages) for detailed command-line documentation. To access the man pages:\n\n```bash\nman geai\n```\n\n#### Setting up Man Pages Access\n\nIf you're using a virtual environment, you'll need to configure your system to find the man pages. Add the following to your shell configuration file (`.bashrc`, `.zshrc`, etc.):\n\n```bash\n# For macOS\nif [ -n \"$VIRTUAL_ENV\" ]; then\n export MANPATH=\"$VIRTUAL_ENV/share/man:$MANPATH\"\nfi\n\n# For Linux\nif [ -n \"$VIRTUAL_ENV\" ]; then\n export MANPATH=\"$VIRTUAL_ENV/man:$MANPATH\"\nfi\n```\n\nAfter adding this configuration:\n1. Reload your shell configuration: `source ~/.bashrc` or `source ~/.zshrc`\n2. The man pages will be available when your virtual environment is active\n\n## Bugs and suggestions\nTo report any bug, request features or make any suggestions, the following email is available:\n\n<geai-sdk@globant.com>\n\n## Authors\nCopyright 2025, Globant. All rights reserved\n",
"bugtrack_url": null,
"license": null,
"summary": "Software Development Kit to interact with Globant Enterprise AI.",
"version": "0.2.6",
"project_urls": null,
"split_keywords": [
"geai",
" pygeai"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "853cbb997768f37b013e9f8db39d2670727784612ed8f90d155e87990f0b6c1e",
"md5": "060602b8ed27e1f6a184974b94c75362",
"sha256": "32f38be9a4dee3ace8652b3747470a84adfcff49d3f7385d8100f7c3b9fafae2"
},
"downloads": -1,
"filename": "pygeai-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "060602b8ed27e1f6a184974b94c75362",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 345742,
"upload_time": "2025-05-21T16:35:43",
"upload_time_iso_8601": "2025-05-21T16:35:43.946674Z",
"url": "https://files.pythonhosted.org/packages/85/3c/bb997768f37b013e9f8db39d2670727784612ed8f90d155e87990f0b6c1e/pygeai-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2b8eb3ad1dad3909df11d5a5fb5c51f44547af1780beaeb5faabfba00ddd0540",
"md5": "53ed93c4026da5ddb82045bac88c598f",
"sha256": "8881220db0fccc5d85ab13320e1d2ef66dac76d536a3e27fd71d67895274a57d"
},
"downloads": -1,
"filename": "pygeai-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "53ed93c4026da5ddb82045bac88c598f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 241898,
"upload_time": "2025-05-21T16:35:45",
"upload_time_iso_8601": "2025-05-21T16:35:45.157063Z",
"url": "https://files.pythonhosted.org/packages/2b/8e/b3ad1dad3909df11d5a5fb5c51f44547af1780beaeb5faabfba00ddd0540/pygeai-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-05-21 16:35:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pygeai"
}
