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

pygeai/_docs/source/conf.py

@@ -8,23 +8,45 @@
 
 import os
 import sys
+from datetime import datetime
+
 sys.path.insert(0, os.path.abspath('../..'))
 
+# Import version from package
+import pygeai
 
 project = 'PyGEAI'
-copyright = '2024, Globant'
 author = 'Globant'
-release = 'v0.1.1'
+copyright = f'{datetime.now().year}, {author}'
+release = pygeai.__version__
+version = '.'.join(release.split('.')[:2])  # e.g., '0.6' from '0.6.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc', 'sphinx_markdown_builder']
+extensions = [
+    'sphinx.ext.autodoc',       # Auto-generate docs from docstrings
+    'sphinx.ext.napoleon',      # Support for Google/NumPy style docstrings
+    'sphinx.ext.viewcode',      # Add links to source code
+    'sphinx.ext.intersphinx',   # Link to other project documentation
+    'sphinx.ext.autosummary',   # Generate summary tables
+    'sphinx_markdown_builder',  # Build markdown output
+]
 
 templates_path = ['_templates']
-exclude_patterns = []
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+]
 
+# Language
+language = 'en'
 
+# Suppress specific warnings
+suppress_warnings = [
+    'ref.duplicate',  # Suppress duplicate implicit target warnings
+]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -32,14 +54,64 @@ exclude_patterns = []
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
-# Custom
+# Theme options
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': True,
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False,
+}
+
+# HTML metadata
+html_title = f'{project} v{release} Documentation'
+html_short_title = f'{project} v{version}'
 html_show_sourcelink = False
 html_show_sphinx = False
 
+# -- Autodoc configuration ---------------------------------------------------
+
 autodoc_default_options = {
     'members': True,
-    'undoc-members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': False,  # Hide undocumented members
+    'exclude-members': '__weakref__',
     'show-inheritance': True,
+    'inherited-members': False,
 }
 
+# Type hints configuration
+autodoc_typehints = 'description'
+autodoc_typehints_description_target = 'documented'
+
+# Mock imports for packages not available during build
 autodoc_mock_imports = []
+
+# -- Intersphinx configuration -----------------------------------------------
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'requests': ('https://requests.readthedocs.io/en/latest/', None),
+}
+
+# -- Napoleon configuration --------------------------------------------------
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True

pygeai/_docs/source/content/api_reference/admin.rst

@@ -0,0 +1,161 @@
+Administration
+==============
+
+The Admin module provides administrative functionality for managing organizations, projects, and API tokens in Globant Enterprise AI. This module is primarily used for validation, authorization checks, and retrieving project information.
+
+This section covers:
+
+* Validating API tokens
+* Getting authorized organizations
+* Getting authorized projects
+* Retrieving project API tokens
+* Checking project visibility
+
+For each operation, you have two implementation options:
+
+* `Command Line`_
+* `Low-Level Service Layer`_
+
+.. note::
+   The Admin module currently does not have a High-Level Service Layer (Manager class).
+
+
+Validate API Token
+~~~~~~~~~~~~~~~~~~
+
+Validates an API token and returns information about the organization and project it belongs to.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai admin validate-token
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.admin.clients import AdminClient
+
+    client = AdminClient()
+    
+    result = client.validate_api_token()
+    print(result)
+
+
+Get Authorized Organizations
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Retrieves a list of organizations that the current user is authorized to access.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai admin get-orgs
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.admin.clients import AdminClient
+
+    client = AdminClient()
+    
+    organizations = client.get_authorized_organizations()
+    print(organizations)
+
+
+Get Authorized Projects by Organization
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Retrieves a list of projects within a specific organization that the current user can access.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai admin get-projects --org "my-organization"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.admin.clients import AdminClient
+
+    client = AdminClient()
+    
+    projects = client.get_authorized_projects_by_organization(
+        organization="my-organization"
+    )
+    print(projects)
+
+
+Get Project API Token
+~~~~~~~~~~~~~~~~~~~~~
+
+Retrieves the API token for a specific project using an access token.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai admin get-project-api-token \
+      --org "my-organization" \
+      --project "my-project" \
+      --access-token "your-access-token"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.admin.clients import AdminClient
+
+    client = AdminClient()
+    
+    api_token = client.get_project_api_token(
+        organization="my-organization",
+        project="my-project",
+        access_token="your-access-token"
+    )
+    print(api_token)
+
+
+Get Project Visibility
+~~~~~~~~~~~~~~~~~~~~~~
+
+Checks the visibility settings of a specific project.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai admin get-project-visibility \
+      --org "my-organization" \
+      --project "my-project" \
+      --access-token "your-access-token"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.admin.clients import AdminClient
+
+    client = AdminClient()
+    
+    visibility = client.get_project_visibility(
+        organization="my-organization",
+        project="my-project",
+        access_token="your-access-token"
+    )
+    print(visibility)

pygeai/_docs/source/content/api_reference/assistant.rst

@@ -0,0 +1,326 @@
+Assistant Management
+====================
+
+The Assistant module provides functionality to create, manage, and interact with AI assistants in Globant Enterprise AI. Assistants can be of different types (chat, text, RAG) and are configured with specific prompts, LLM settings, and behaviors.
+
+This section covers:
+
+* Creating assistants (chat, text, RAG)
+* Retrieving assistant information
+* Updating assistant configuration
+* Deleting assistants
+* Sending chat requests to assistants
+* Managing assistant requests
+
+For each operation, you have three implementation options:
+
+* `Command Line`_
+* `Low-Level Service Layer`_
+* `High-Level Service Layer`_
+
+
+Create Chat Assistant
+~~~~~~~~~~~~~~~~~~~~~
+
+Creates a new chat assistant with specified configuration including LLM settings, welcome data, and guardrails.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai assistant create \
+      --type chat \
+      --name "Customer Support Bot" \
+      --prompt "You are a helpful customer support assistant"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    response = client.create_assistant(
+        assistant_type="chat",
+        name="Customer Support Bot",
+        prompt="You are a helpful customer support assistant",
+        description="Handles customer inquiries"
+    )
+    print(response)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+    from pygeai.core.models import ChatAssistant, LlmSettings
+    from pygeai.core.services.llm.model import Model
+    from pygeai.core.services.llm.providers import Provider
+
+    manager = AssistantManager()
+
+    llm_settings = LlmSettings(
+        provider_name=Provider.OPENAI,
+        model_name=Model.OpenAI.GPT_4,
+        temperature=0.7,
+        max_tokens=1000
+    )
+
+    assistant = ChatAssistant(
+        name="Customer Support Bot",
+        description="Handles customer inquiries",
+        prompt="You are a helpful customer support assistant",
+        llm_settings=llm_settings
+    )
+
+    response = manager.create_assistant(assistant)
+    print(f"Response: {response}")
+
+
+Get Assistant Data
+~~~~~~~~~~~~~~~~~~
+
+Retrieves information about a specific assistant.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai assistant get-assistant --detail full
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    assistant_data = client.get_assistant_data(
+        assistant_id="assistant-uuid",
+        detail="full"
+    )
+    print(assistant_data)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+
+    manager = AssistantManager()
+    
+    assistant = manager.get_assistant_data(
+        assistant_id="assistant-uuid",
+        detail="full"
+    )
+    print(f"Assistant: {assistant}")
+
+
+Update Assistant
+~~~~~~~~~~~~~~~~
+
+Updates an existing assistant's configuration.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai assistant update \
+      --name "Customer Support Bot" \
+      --prompt "You are an expert customer support assistant"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    response = client.update_assistant(
+        assistant_id="assistant-uuid",
+        prompt="You are an expert customer support assistant"
+    )
+    print(response)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+    from pygeai.core.models import ChatAssistant
+
+    manager = AssistantManager()
+    
+    assistant = manager.get_assistant_data(assistant_id="assistant-uuid")
+    assistant.prompt = "You are an expert customer support assistant"
+    
+    response = manager.update_assistant(
+        assistant=assistant,
+        action="saveNewRevision"
+    )
+    print(f"Response: {response}")
+
+
+Delete Assistant
+~~~~~~~~~~~~~~~~
+
+Deletes an assistant from the system.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai assistant delete --name "Customer Support Bot"
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    response = client.delete_assistant(assistant_id="assistant-uuid")
+    print(response)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+
+    manager = AssistantManager()
+    
+    response = manager.delete_assistant(assistant_id="assistant-uuid")
+    print(f"Response: {response}")
+
+
+Send Chat Request
+~~~~~~~~~~~~~~~~~
+
+Sends a chat message to an assistant and receives a response.
+
+Command Line
+^^^^^^^^^^^^
+
+.. code-block:: shell
+
+    geai assistant chat \
+      --name "Customer Support Bot" \
+      --msg '[{"role": "user", "content": "Hello, I need help"}]'
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    messages = [
+        {"role": "user", "content": "Hello, I need help"}
+    ]
+    
+    response = client.send_chat_request(
+        assistant_name="Customer Support Bot",
+        messages=messages
+    )
+    print(response)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+    from pygeai.core.models import ChatMessageList, ChatMessage
+
+    manager = AssistantManager()
+    
+    messages = ChatMessageList(
+        messages=[
+            ChatMessage(role="user", "Hello, I need help")
+        ]
+    )
+    
+    response = manager.chat_completion(
+        assistant_name="Customer Support Bot",
+        messages=messages
+    )
+    print(f"Response: {response}")
+
+
+Get Request Status
+~~~~~~~~~~~~~~~~~~
+
+Checks the status of an asynchronous assistant request.
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    status = client.get_request_status(request_id="request-uuid")
+    print(status)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+
+    manager = AssistantManager()
+    
+    status = manager.get_request_status(request_id="request-uuid")
+    print(f"Status: {status}")
+
+
+Cancel Request
+~~~~~~~~~~~~~~
+
+Cancels a pending assistant request.
+
+Low-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.clients import AssistantClient
+
+    client = AssistantClient()
+    
+    response = client.cancel_request(request_id="request-uuid")
+    print(response)
+
+High-Level Service Layer
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    from pygeai.assistant.managers import AssistantManager
+
+    manager = AssistantManager()
+    
+    response = manager.cancel_request(request_id="request-uuid")
+    print(f"Response: {response}")