construct-labs-crm-env 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

construct_labs_crm_env/tools.py

@@ -0,0 +1,611 @@
+"""Tool definitions for the CRM Agent Environment.
+
+This module contains the static tool definitions in OpenAI function calling format.
+These define the available actions an agent can take in the CRM environment.
+"""
+
+from typing import Any
+
+# Type alias for tool definitions
+ToolDefinition = dict[str, Any]
+
+# =============================================================================
+# Company Tools
+# =============================================================================
+
+LIST_COMPANIES: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "list_companies",
+        "description": "List all companies in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "limit": {
+                    "type": "integer",
+                    "default": 60,
+                    "description": "Maximum number of companies to return (max 200)",
+                },
+                "starting_after": {
+                    "type": "string",
+                    "description": "Cursor for pagination - returns objects after this ID",
+                },
+                "ending_before": {
+                    "type": "string",
+                    "description": "Cursor for pagination - returns objects before this ID",
+                },
+                "order_by": {
+                    "type": "string",
+                    "description": "Order by: field_name[ASC|DESC]",
+                },
+                "filter": {
+                    "type": "string",
+                    "description": "Filter: field[eq|gt|lt|contains]:value",
+                },
+                "depth": {
+                    "type": "integer",
+                    "default": 1,
+                    "description": "Relation depth: 0=primary only, 1=include relations",
+                },
+            },
+            "required": [],
+        },
+    },
+}
+
+GET_COMPANY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "get_company",
+        "description": "Get details of a specific company",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the company to retrieve",
+                },
+                "depth": {
+                    "type": "integer",
+                    "default": 1,
+                    "description": "Relation depth: 0=primary only, 1=include relations",
+                },
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+CREATE_COMPANY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "create_company",
+        "description": "Create a new company in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "company_name": {
+                    "type": "string",
+                    "description": "Name of the company",
+                },
+                "company_domain": {
+                    "type": "string",
+                    "description": "Domain/website of the company",
+                },
+                "company_address": {
+                    "type": "string",
+                    "description": "Address of the company",
+                },
+                "company_employees": {
+                    "type": "integer",
+                    "description": "Number of employees",
+                },
+            },
+            "required": ["company_name"],
+        },
+    },
+}
+
+UPDATE_COMPANY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "update_company",
+        "description": "Update an existing company",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the company to update",
+                },
+                "company_name": {"type": "string"},
+                "company_domain": {"type": "string"},
+                "company_address": {"type": "string"},
+                "company_employees": {"type": "integer"},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+DELETE_COMPANY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "delete_company",
+        "description": "Delete a company from the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the company to delete",
+                },
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+# =============================================================================
+# Person/Contact Tools
+# =============================================================================
+
+LIST_PEOPLE: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "list_people",
+        "description": "List all contacts/people in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "limit": {
+                    "type": "integer",
+                    "default": 60,
+                    "description": "Maximum number of contacts to return (max 200)",
+                },
+                "starting_after": {"type": "string"},
+                "ending_before": {"type": "string"},
+                "order_by": {"type": "string"},
+                "filter": {"type": "string"},
+                "depth": {"type": "integer", "default": 1},
+            },
+            "required": [],
+        },
+    },
+}
+
+GET_PERSON: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "get_person",
+        "description": "Get details of a specific contact",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the contact to retrieve",
+                },
+                "depth": {"type": "integer", "default": 1},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+CREATE_PERSON: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "create_person",
+        "description": "Create a new contact/person in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "person_first_name": {
+                    "type": "string",
+                    "description": "First name",
+                },
+                "person_last_name": {
+                    "type": "string",
+                    "description": "Last name",
+                },
+                "person_email": {
+                    "type": "string",
+                    "description": "Email address",
+                },
+                "person_phone": {
+                    "type": "string",
+                    "description": "Phone number",
+                },
+                "person_company_id": {
+                    "type": "string",
+                    "description": "ID of associated company",
+                },
+                "person_job_title": {
+                    "type": "string",
+                    "description": "Job title",
+                },
+            },
+            "required": ["person_first_name", "person_last_name"],
+        },
+    },
+}
+
+UPDATE_PERSON: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "update_person",
+        "description": "Update an existing contact",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the contact to update",
+                },
+                "person_first_name": {"type": "string"},
+                "person_last_name": {"type": "string"},
+                "person_email": {"type": "string"},
+                "person_phone": {"type": "string"},
+                "person_job_title": {"type": "string"},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+DELETE_PERSON: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "delete_person",
+        "description": "Delete a contact from the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the contact to delete",
+                },
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+# =============================================================================
+# Opportunity Tools
+# =============================================================================
+
+LIST_OPPORTUNITIES: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "list_opportunities",
+        "description": "List all opportunities/deals in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "limit": {
+                    "type": "integer",
+                    "default": 60,
+                    "description": "Maximum number to return (max 200)",
+                },
+                "starting_after": {"type": "string"},
+                "ending_before": {"type": "string"},
+                "order_by": {"type": "string"},
+                "filter": {"type": "string"},
+                "depth": {"type": "integer", "default": 1},
+            },
+            "required": [],
+        },
+    },
+}
+
+GET_OPPORTUNITY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "get_opportunity",
+        "description": "Get details of a specific opportunity",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the opportunity",
+                },
+                "depth": {"type": "integer", "default": 1},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+CREATE_OPPORTUNITY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "create_opportunity",
+        "description": "Create a new opportunity/deal",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "opportunity_name": {
+                    "type": "string",
+                    "description": "Name of the opportunity",
+                },
+                "opportunity_amount": {
+                    "type": "number",
+                    "description": "Deal value",
+                },
+                "opportunity_stage": {
+                    "type": "string",
+                    "enum": ["NEW", "MEETING", "PROPOSAL", "WON", "LOST"],
+                    "description": "Sales stage",
+                },
+                "opportunity_close_date": {
+                    "type": "string",
+                    "description": "Expected close date (ISO format)",
+                },
+                "opportunity_company_id": {
+                    "type": "string",
+                    "description": "Associated company ID",
+                },
+                "opportunity_person_id": {
+                    "type": "string",
+                    "description": "Point of contact ID",
+                },
+            },
+            "required": ["opportunity_name"],
+        },
+    },
+}
+
+UPDATE_OPPORTUNITY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "update_opportunity",
+        "description": "Update an existing opportunity",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the opportunity to update",
+                },
+                "opportunity_name": {"type": "string"},
+                "opportunity_amount": {"type": "number"},
+                "opportunity_stage": {
+                    "type": "string",
+                    "enum": ["NEW", "MEETING", "PROPOSAL", "WON", "LOST"],
+                },
+                "opportunity_close_date": {"type": "string"},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+DELETE_OPPORTUNITY: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "delete_opportunity",
+        "description": "Delete an opportunity",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the opportunity to delete",
+                },
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+# =============================================================================
+# Note Tools
+# =============================================================================
+
+LIST_NOTES: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "list_notes",
+        "description": "List all notes in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "limit": {
+                    "type": "integer",
+                    "default": 10,
+                    "description": "Maximum number of notes to return",
+                },
+            },
+            "required": [],
+        },
+    },
+}
+
+CREATE_NOTE: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "create_note",
+        "description": "Create a note attached to a record",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "note_body": {
+                    "type": "string",
+                    "description": "Content of the note",
+                },
+                "note_target_id": {
+                    "type": "string",
+                    "description": "ID of record to attach note to",
+                },
+                "note_target_type": {
+                    "type": "string",
+                    "enum": ["company", "person", "opportunity"],
+                    "description": "Type of record",
+                },
+            },
+            "required": ["note_body"],
+        },
+    },
+}
+
+# =============================================================================
+# Task Tools
+# =============================================================================
+
+LIST_TASKS: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "list_tasks",
+        "description": "List all tasks in the CRM",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "limit": {
+                    "type": "integer",
+                    "default": 10,
+                    "description": "Maximum number of tasks to return",
+                },
+            },
+            "required": [],
+        },
+    },
+}
+
+CREATE_TASK: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "create_task",
+        "description": "Create a task, optionally linked to a record",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "task_title": {
+                    "type": "string",
+                    "description": "Title of the task",
+                },
+                "task_body": {
+                    "type": "string",
+                    "description": "Description",
+                },
+                "task_due_date": {
+                    "type": "string",
+                    "description": "Due date (ISO format)",
+                },
+                "task_status": {
+                    "type": "string",
+                    "enum": ["TODO", "IN_PROGRESS", "DONE"],
+                    "description": "Status",
+                },
+                "task_target_id": {
+                    "type": "string",
+                    "description": "ID of record to link task to",
+                },
+                "task_target_type": {
+                    "type": "string",
+                    "enum": ["company", "person", "opportunity"],
+                    "description": "Type of record",
+                },
+            },
+            "required": ["task_title"],
+        },
+    },
+}
+
+UPDATE_TASK: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "update_task",
+        "description": "Update an existing task",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the task to update",
+                },
+                "task_title": {"type": "string"},
+                "task_body": {"type": "string"},
+                "task_due_date": {"type": "string"},
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+COMPLETE_TASK: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "complete_task",
+        "description": "Mark a task as complete",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "record_id": {
+                    "type": "string",
+                    "description": "ID of the task to complete",
+                },
+            },
+            "required": ["record_id"],
+        },
+    },
+}
+
+# =============================================================================
+# Submit Answer Tool
+# =============================================================================
+
+SUBMIT_ANSWER: ToolDefinition = {
+    "type": "function",
+    "function": {
+        "name": "submit_answer",
+        "description": "Submit final answer and end the session",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "answer": {
+                    "type": "string",
+                    "description": "The final answer based on CRM data",
+                },
+            },
+            "required": ["answer"],
+        },
+    },
+}
+
+# =============================================================================
+# All Tools - Combined list
+# =============================================================================
+
+DEFAULT_TOOLS: list[ToolDefinition] = [
+    # Company
+    LIST_COMPANIES,
+    GET_COMPANY,
+    CREATE_COMPANY,
+    UPDATE_COMPANY,
+    DELETE_COMPANY,
+    # Person
+    LIST_PEOPLE,
+    GET_PERSON,
+    CREATE_PERSON,
+    UPDATE_PERSON,
+    DELETE_PERSON,
+    # Opportunity
+    LIST_OPPORTUNITIES,
+    GET_OPPORTUNITY,
+    CREATE_OPPORTUNITY,
+    UPDATE_OPPORTUNITY,
+    DELETE_OPPORTUNITY,
+    # Note
+    LIST_NOTES,
+    CREATE_NOTE,
+    # Task
+    LIST_TASKS,
+    CREATE_TASK,
+    UPDATE_TASK,
+    COMPLETE_TASK,
+    # Answer
+    SUBMIT_ANSWER,
+]

{construct_labs_crm_env-0.1.2.dist-info → construct_labs_crm_env-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: construct-labs-crm-env
-Version: 0.1.2
+Version: 0.1.3
 Summary: CRM Agent Environment SDK by Construct Labs - Train RL agents to interact with CRM systems
 Project-URL: Homepage, https://construct-labs.com
 Author-email: Construct Labs GmbH <hello@construct-labs.com>

construct_labs_crm_env-0.1.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+construct_labs_crm_env/__init__.py,sha256=XRei6wERXV6MMV168AkgeAMlsZLRSdXA2pPg8icfWQ4,917
+construct_labs_crm_env/client.py,sha256=OPXcNT1QTNST_-OdI1jQtcVVrdIQKmmpH5JmJCNVS14,18980
+construct_labs_crm_env/models.py,sha256=bs-n9FcWcR8DqKvurmm0wUebWBWp9hG6Zaj6s7jEptg,9200
+construct_labs_crm_env/protocol.py,sha256=h_7-0XaV9gBNHiSXoW4aITSD9K21R1Swc5yZR6LF50A,671
+construct_labs_crm_env/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+construct_labs_crm_env/tools.py,sha256=zdYlJfTr5d3El9awlg-VeTommJ6nCNAd13E09drxv8E,18854
+construct_labs_crm_env-0.1.3.dist-info/METADATA,sha256=oPrpeZNalu8QgHjAF34NgyO6vIvrrfp_1Le5TfVraAU,11923
+construct_labs_crm_env-0.1.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+construct_labs_crm_env-0.1.3.dist-info/licenses/LICENSE,sha256=zPT_KqeG9QTE0zTfKGheMHluFJB1fn_bNgNehnnpXGM,2210
+construct_labs_crm_env-0.1.3.dist-info/RECORD,,

construct_labs_crm_env-0.1.3.dist-info/licenses/LICENSE

@@ -0,0 +1,56 @@
+Construct Labs CRM Environment SDK - Evaluation License
+
+Copyright (c) 2024 Construct Labs GmbH. All rights reserved.
+
+TERMS AND CONDITIONS
+
+1. EVALUATION LICENSE
+   This software and associated documentation files (the "Software") are
+   provided by Construct Labs GmbH for evaluation purposes only.
+
+   You may use this Software solely to evaluate its functionality and
+   suitability for your needs. This evaluation license does not grant
+   any rights to use the Software in production environments.
+
+2. RESTRICTIONS
+   Under this evaluation license, you may NOT:
+   - Deploy the Software in production environments
+   - Use the Software for commercial purposes
+   - Train models intended for production use
+   - Distribute, sublicense, or transfer the Software to third parties
+   - Remove or alter any proprietary notices
+
+3. COMMERCIAL LICENSE REQUIRED
+   Any use beyond evaluation requires a commercial license agreement
+   with Construct Labs GmbH. This includes but is not limited to:
+   - Production deployment
+   - Commercial use of any kind
+   - Training models for production use
+   - Integration into commercial products or services
+
+   To obtain a commercial license, contact:
+   
+   Construct Labs GmbH
+   Email: hello@construct-labs.com
+
+4. DATA AND PRIVACY
+   During evaluation, the Software may connect to Construct Labs servers.
+   Usage data may be collected for service improvement purposes.
+
+5. WARRANTY DISCLAIMER
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+6. LIMITATION OF LIABILITY
+   IN NO EVENT SHALL CONSTRUCT LABS GMBH BE LIABLE FOR ANY CLAIM, DAMAGES OR
+   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE.
+
+7. TERMINATION
+   This evaluation license may be terminated by Construct Labs GmbH at any
+   time. Your rights under this license will terminate automatically without
+   notice if you fail to comply with any of its terms.
+
+For licensing inquiries: hello@construct-labs.com