pygeai 0.6.0b6__py3-none-any.whl → 0.6.0b7__py3-none-any.whl

pygeai/_docs/source/index.rst

@@ -1,21 +1,73 @@
-PyGEAI documentation
+PyGEAI Documentation
 ====================
 
-PyGEAI is a Python SDK developed to interact with the different components that constitute GEAI.
-It’s composed of several resources that allow developers to work with GEAI’s modules in an easy and simple manner.
-The SDK is composed of libraries, tools, documentation and code samples.
-The goal is to provide an easier experience working with GEAI, without any overhead of setup and configuration.
+PyGEAI is a Python SDK developed to interact with the different components that constitute GEAI (Globant Enterprise AI).
+It's composed of several resources that allow developers to work with GEAI's modules in an easy and simple manner.
+
+The SDK provides libraries, tools, documentation, and code samples to deliver an easier development experience
+with GEAI, without overhead of setup and configuration.
+
+Getting Started
+---------------
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    content/intro
    content/quickstart
+
+Core Features & API Reference
+-------------------------------
+
+Complete reference for all PyGEAI modules and APIs.
+
+.. toctree::
+   :maxdepth: 2
+
    content/api_reference
+
+The API Reference includes:
+
+* **Authentication** - OAuth2, API tokens, user profiles
+* **Administration** - Token validation, organization access
+* **Assistants** - Create and manage AI assistants
+* **Chat** - Chat completions and streaming
+* **Embeddings** - Text embeddings for similarity search
+* **RAG** - Retrieval-Augmented Generation assistants
+* **Reranking** - Document reranking for relevance
+* **Projects** - Project and organization management
+* **Health** - Service status and monitoring
+
+Advanced Features
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
    content/ai_lab
-   content/samples
+
+Tools & Utilities
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
    content/cli
    content/chat_gui
    content/debugger
+
+Additional Resources
+--------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   content/samples
    modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pygeai/_docs/source/pygeai.auth.rst

@@ -0,0 +1,29 @@
+pygeai.auth package
+===================
+
+Submodules
+----------
+
+pygeai.auth.clients module
+--------------------------
+
+.. automodule:: pygeai.auth.clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+pygeai.auth.endpoints module
+----------------------------
+
+.. automodule:: pygeai.auth.endpoints
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.auth
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.cli.commands.rst

@@ -29,6 +29,14 @@ pygeai.cli.commands.assistant module
    :show-inheritance:
    :undoc-members:
 
+pygeai.cli.commands.auth module
+-------------------------------
+
+.. automodule:: pygeai.cli.commands.auth
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.cli.commands.base module
 -------------------------------
 
@@ -69,6 +77,14 @@ pygeai.cli.commands.configuration module
    :show-inheritance:
    :undoc-members:
 
+pygeai.cli.commands.docs module
+-------------------------------
+
+.. automodule:: pygeai.cli.commands.docs
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.cli.commands.embeddings module
 -------------------------------------
 

pygeai/_docs/source/pygeai.core.utils.rst

@@ -12,6 +12,22 @@ pygeai.core.utils.console module
    :show-inheritance:
    :undoc-members:
 
+pygeai.core.utils.parsers module
+--------------------------------
+
+.. automodule:: pygeai.core.utils.parsers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+pygeai.core.utils.validators module
+-----------------------------------
+
+.. automodule:: pygeai.core.utils.validators
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 Module contents
 ---------------
 

pygeai/_docs/source/pygeai.rst

@@ -9,6 +9,7 @@ Subpackages
 
    pygeai.admin
    pygeai.assistant
+   pygeai.auth
    pygeai.chat
    pygeai.cli
    pygeai.core

pygeai/_docs/source/pygeai.tests.auth.rst

@@ -0,0 +1,21 @@
+pygeai.tests.auth package
+=========================
+
+Submodules
+----------
+
+pygeai.tests.auth.test\_clients module
+--------------------------------------
+
+.. automodule:: pygeai.tests.auth.test_clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.auth
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.cli.commands.rst

@@ -44,6 +44,14 @@ pygeai.tests.cli.commands.test\_embeddings module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.cli.commands.test\_evaluation module
+-------------------------------------------------
+
+.. automodule:: pygeai.tests.cli.commands.test_evaluation
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.cli.commands.test\_feedback module
 -----------------------------------------------
 
@@ -108,6 +116,14 @@ pygeai.tests.cli.commands.test\_rerank module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.cli.commands.test\_secrets module
+----------------------------------------------
+
+.. automodule:: pygeai.tests.cli.commands.test_secrets
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.cli.commands.test\_show\_help module
 -------------------------------------------------
 

pygeai/_docs/source/pygeai.tests.core.base.rst

@@ -28,6 +28,14 @@ pygeai.tests.core.base.test\_models module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.core.base.test\_responses module
+---------------------------------------------
+
+.. automodule:: pygeai.tests.core.base.test_responses
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 Module contents
 ---------------
 

pygeai/_docs/source/pygeai.tests.core.files.rst

@@ -20,6 +20,14 @@ pygeai.tests.core.files.test\_managers module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.core.files.test\_mappers module
+--------------------------------------------
+
+.. automodule:: pygeai.tests.core.files.test_mappers
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.core.files.test\_models module
 -------------------------------------------
 

pygeai/_docs/source/pygeai.tests.core.plugins.rst

@@ -0,0 +1,21 @@
+pygeai.tests.core.plugins package
+=================================
+
+Submodules
+----------
+
+pygeai.tests.core.plugins.test\_clients module
+----------------------------------------------
+
+.. automodule:: pygeai.tests.core.plugins.test_clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.core.plugins
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.core.rst

@@ -13,6 +13,7 @@ Subpackages
    pygeai.tests.core.feedback
    pygeai.tests.core.files
    pygeai.tests.core.llm
+   pygeai.tests.core.plugins
    pygeai.tests.core.rerank
    pygeai.tests.core.secrets
    pygeai.tests.core.services

pygeai/_docs/source/pygeai.tests.evaluation.dataset.rst

@@ -0,0 +1,21 @@
+pygeai.tests.evaluation.dataset package
+=======================================
+
+Submodules
+----------
+
+pygeai.tests.evaluation.dataset.test\_clients module
+----------------------------------------------------
+
+.. automodule:: pygeai.tests.evaluation.dataset.test_clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.evaluation.dataset
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.evaluation.plan.rst

@@ -0,0 +1,21 @@
+pygeai.tests.evaluation.plan package
+====================================
+
+Submodules
+----------
+
+pygeai.tests.evaluation.plan.test\_clients module
+-------------------------------------------------
+
+.. automodule:: pygeai.tests.evaluation.plan.test_clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.evaluation.plan
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.evaluation.result.rst

@@ -0,0 +1,21 @@
+pygeai.tests.evaluation.result package
+======================================
+
+Submodules
+----------
+
+pygeai.tests.evaluation.result.test\_clients module
+---------------------------------------------------
+
+.. automodule:: pygeai.tests.evaluation.result.test_clients
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.evaluation.result
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.evaluation.rst

@@ -0,0 +1,20 @@
+pygeai.tests.evaluation package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pygeai.tests.evaluation.dataset
+   pygeai.tests.evaluation.plan
+   pygeai.tests.evaluation.result
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.evaluation
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.integration.lab.processes.rst

@@ -12,6 +12,14 @@ pygeai.tests.integration.lab.processes.test\_create\_process module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.integration.lab.processes.test\_create\_task module
+----------------------------------------------------------------
+
+.. automodule:: pygeai.tests.integration.lab.processes.test_create_task
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.integration.lab.processes.test\_delete\_process module
 -------------------------------------------------------------------
 

pygeai/_docs/source/pygeai.tests.organization.rst

@@ -36,6 +36,14 @@ pygeai.tests.organization.test\_mappers module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.organization.test\_responses module
+------------------------------------------------
+
+.. automodule:: pygeai.tests.organization.test_responses
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 Module contents
 ---------------
 

pygeai/_docs/source/pygeai.tests.rst

@@ -9,10 +9,12 @@ Subpackages
 
    pygeai.tests.admin
    pygeai.tests.assistants
+   pygeai.tests.auth
    pygeai.tests.chat
    pygeai.tests.cli
    pygeai.tests.core
    pygeai.tests.dbg
+   pygeai.tests.evaluation
    pygeai.tests.gam
    pygeai.tests.health
    pygeai.tests.integration

pygeai/_docs/source/pygeai.tests.snippets.auth.rst

@@ -0,0 +1,10 @@
+pygeai.tests.snippets.auth package
+==================================
+
+Module contents
+---------------
+
+.. automodule:: pygeai.tests.snippets.auth
+   :members:
+   :show-inheritance:
+   :undoc-members:

pygeai/_docs/source/pygeai.tests.snippets.organization.rst

@@ -28,6 +28,22 @@ pygeai.tests.snippets.organization.export\_request\_data module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.snippets.organization.get\_memberships module
+----------------------------------------------------------
+
+.. automodule:: pygeai.tests.snippets.organization.get_memberships
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+pygeai.tests.snippets.organization.get\_organization\_members module
+--------------------------------------------------------------------
+
+.. automodule:: pygeai.tests.snippets.organization.get_organization_members
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.snippets.organization.get\_project\_data module
 ------------------------------------------------------------
 
@@ -44,6 +60,30 @@ pygeai.tests.snippets.organization.get\_project\_list module
    :show-inheritance:
    :undoc-members:
 
+pygeai.tests.snippets.organization.get\_project\_members module
+---------------------------------------------------------------
+
+.. automodule:: pygeai.tests.snippets.organization.get_project_members
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+pygeai.tests.snippets.organization.get\_project\_memberships module
+-------------------------------------------------------------------
+
+.. automodule:: pygeai.tests.snippets.organization.get_project_memberships
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+pygeai.tests.snippets.organization.get\_project\_roles module
+-------------------------------------------------------------
+
+.. automodule:: pygeai.tests.snippets.organization.get_project_roles
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 pygeai.tests.snippets.organization.get\_project\_tokens module
 --------------------------------------------------------------
 

pygeai/_docs/source/pygeai.tests.snippets.rst

@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    pygeai.tests.snippets.assistants
+   pygeai.tests.snippets.auth
    pygeai.tests.snippets.chat
    pygeai.tests.snippets.embeddings
    pygeai.tests.snippets.evaluation

pygeai/admin/clients.py

@@ -1,11 +1,11 @@
-import json
-from json import JSONDecodeError
 
 from pygeai import logger
 from pygeai.admin.endpoints import GET_API_TOKEN_VALIDATION_V1, GET_AUTHORIZED_ORGANIZATIONS_V1, \
     GET_AUTHORIZED_PROJECTS_V1, GET_PROJECT_VISIBILITY_V1, GET_PROJECT_API_TOKEN_V1
 from pygeai.core.base.clients import BaseClient
 from pygeai.core.common.exceptions import InvalidAPIResponseException
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
 
 
 class AdminClient(BaseClient):
@@ -17,12 +17,7 @@ class AdminClient(BaseClient):
         :return: dict - The API response containing organization and project information in JSON format.
         """
         response = self.api_service.get(endpoint=GET_API_TOKEN_VALIDATION_V1)
-        try:
-            result = response.json()
-            return result
-        except JSONDecodeError as e:
-            logger.error(f"Unable to validate API token: JSON parsing error (status {response.status_code}): {e}. Response: {response.text}")
-            raise InvalidAPIResponseException(f"Unable to validate API token: {response.text}")
+        return parse_json_response(response, "validate API token")
 
     def get_authorized_organizations(self) -> dict:
         """
@@ -31,12 +26,7 @@ class AdminClient(BaseClient):
         :return: dict - The API response containing the list of authorized organizations in JSON format.
         """
         response = self.api_service.get(endpoint=GET_AUTHORIZED_ORGANIZATIONS_V1)
-        try:
-            result = response.json()
-            return result
-        except JSONDecodeError as e:
-            logger.error(f"Unable to retrieve authorized organizations: JSON parsing error (status {response.status_code}): {e}. Response: {response.text}")
-            raise InvalidAPIResponseException(f"Unable to retrieve authorized organizations: {response.text}")
+        return parse_json_response(response, "retrieve authorized organizations")
 
     def get_authorized_projects_by_organization(
             self,
@@ -54,12 +44,7 @@ class AdminClient(BaseClient):
                 "organization": organization
             }
         )
-        try:
-            result = response.json()
-            return result
-        except JSONDecodeError as e:
-            logger.error(f"Unable to retrieve authorized projects for organization '{organization}': JSON parsing error (status {response.status_code}): {e}. Response: {response.text}")
-            raise InvalidAPIResponseException(f"Unable to retrieve authorized projects for organization {organization}: {response.text}")
+        return parse_json_response(response, "retrieve authorized projects for organization", organization=organization)
 
     def get_project_visibility(
             self,
@@ -90,12 +75,7 @@ class AdminClient(BaseClient):
                 "accessToken": access_token
             }
         )
-        try:
-            result = response.json()
-            return result
-        except JSONDecodeError as e:
-            logger.error(f"Unable to retrieve project visibility for organization '{organization}' and project '{project}': JSON parsing error (status {response.status_code}): {e}. Response: {response.text}")
-            raise InvalidAPIResponseException(f"Unable to retrieve project visibility for organization {organization} and project {project}: {response.text}")
+        return parse_json_response(response, "retrieve project visibility", organization=organization, project=project)
 
     def get_project_api_token(
             self,
@@ -127,9 +107,4 @@ class AdminClient(BaseClient):
                 "accessToken": access_token
             }
         )
-        try:
-            result = response.json()
-            return result
-        except JSONDecodeError as e:
-            logger.error(f"Unable to retrieve project API token for organization '{organization}' and project '{project}': JSON parsing error (status {response.status_code}): {e}. Response: {response.text}")
-            raise InvalidAPIResponseException(f"Unable to retrieve project API token for organization {organization} and project {project}: {response.text}")
+        return parse_json_response(response, "retrieve project API token", organization=organization, project=project)