Merge pull request #19 from picahq/feat/action-permission-control

feat: add action control and access permission

Author: paulkr

README.md

@@ -22,6 +22,8 @@ The `PicaClientOptions` class allows you to configure the Pica client with the f
 | --- | --- | --- | --- | --- |
 | server_url | str | No | https://api.picaos.com | URL for self-hosted Pica server. |
 | connectors | List[str] | No | [] | List of connector keys to filter by. Pass ["*"] to initialize all available connectors, or specific connector keys to filter. If empty, no connections will be initialized. |
+| actions | List[str] | No | None | List of action ids to filter by. Default is all actions. |
+| permissions | Literal["read", "write", "admin"] | No | None | Permission level to filter actions by. 'read' allows GET only, 'write' allows POST/PUT/PATCH, 'admin' allows all methods (default: 'admin') |
 | authkit | bool | No | False | If True, the SDK will use Authkit to connect to prompt the user to connect to a platform that they do not currently have access to |
 | identity | str | No | None | Filter connections by specific identity ID. |
 | identity_type | "user", "team", "organization", or "project" | No | None | Filter connections by identity type. |
@@ -52,15 +54,19 @@ pica_client = PicaClient(
         # identity_type="user"
         # identity="user-id",
         # authkit=True,
-
+        # actions=[""], # Initialize specific action ids (e.g. ["conn_mod_def::F_JeJ_A_TKg::cc2kvVQQTiiIiLEDauy6zQ"])
+        # permissions="read", # Filter actions by permission level
+        
         connectors=["*"] # Initialize all available connections for this example
     )
 )
 
+pica_client.initialize()
+
 # Create a LangChain agent with Pica tools
 llm = ChatOpenAI(
     temperature=0, 
-    model="gpt-4o"
+    model="gpt-4.1"
 )
 
 # Create an agent with Pica tools
@@ -95,11 +101,13 @@ from pica_langchain import PicaClient, create_pica_tools
 # Initialize the Pica client
 pica_client = PicaClient(secret="your-pica-secret")
 
+pica_client.initialize()
+
 # Create Pica tools
 tools = create_pica_tools(pica_client)
 
 # Create a custom agent with the tools
-llm = ChatOpenAI(temperature=0, model="gpt-4o")
+llm = ChatOpenAI(temperature=0, model="gpt-4.1")
 agent = initialize_agent(
     tools,
     llm,
@@ -145,7 +153,7 @@ async def main():
     )
 
     # Create an agent with both Pica and MCP tools
-    llm = ChatOpenAI(temperature=0, model="gpt-4o")
+    llm = ChatOpenAI(temperature=0, model="gpt-4.1")
     agent = create_pica_agent(
         client=pica_client,
         llm=llm,

examples/agent_with_allowed_actions.py

@@ -0,0 +1,66 @@
+"""
+Example demonstrating how to use pica-langchain with LangChain streaming responses.
+"""
+
+import os
+import sys
+
+from langchain_openai import ChatOpenAI
+from langchain.agents import AgentType
+from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
+from pica_langchain import PicaClient, create_pica_agent
+from pica_langchain.models import PicaClientOptions
+
+
+def get_env_var(name: str) -> str:
+    """Get environment variable or exit if not set."""
+    value = os.environ.get(name)
+
+    if not value:
+        print(f"ERROR: {name} environment variable must be set")
+        sys.exit(1)
+
+    return value
+
+
+def main():
+    try:
+        # Create an agent with access to only the Send Email action from Gmail
+        pica_client = PicaClient(
+            secret=get_env_var("PICA_SECRET"),
+            options=PicaClientOptions(
+                connectors=["my-gmail-connector-key"],
+                actions=[
+                    "conn_mod_def::F_JeJ_A_TKg::cc2kvVQQTiiIiLEDauy6zQ"
+                ]
+            )
+        )
+
+        pica_client.initialize()
+        
+        llm_with_handler = ChatOpenAI(
+            temperature=0,
+            model="gpt-4.1",
+            streaming=True,
+            callbacks=[StreamingStdOutCallbackHandler()]
+        )
+
+        agent_with_handler = create_pica_agent(
+            client=pica_client,
+            llm=llm_with_handler,
+            agent_type=AgentType.OPENAI_FUNCTIONS,
+        )
+
+        for chunk in agent_with_handler.stream({
+            "input": "What actions do I have access to with Gmail?"
+        }):
+            if 'output' in chunk:
+                print(chunk['output'])
+        
+    except Exception as e:
+        print(f"ERROR: An unexpected error occurred: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main() 

examples/async_with_pica.py

@@ -43,7 +43,7 @@ async def main():
         # Create an LLM with streaming capability
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
             streaming=True,
             callbacks=[StreamingStdOutCallbackHandler()]
         )

examples/authkit_example.py

@@ -34,7 +34,7 @@ def main():
 
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
         )
 
         # Create an agent with Pica tools

examples/confirm_before_executing.py

@@ -93,7 +93,7 @@ def main():
 
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
         )
 
         agent = create_pica_agent(

examples/confirm_before_executing_streaming.py

@@ -142,7 +142,7 @@ async def main():
 
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
             streaming=True,
             callbacks=[StreamingStdOutCallbackHandler()]
         )

examples/streaming_example.py

@@ -34,7 +34,7 @@ def main():
 
         llm_with_handler = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
             streaming=True,
             callbacks=[StreamingStdOutCallbackHandler()]
         )

examples/streaming_with_intermediate_steps.py

@@ -34,7 +34,7 @@ def main():
 
         llm_with_handler = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
             streaming=True,
             callbacks=[StreamingStdOutCallbackHandler()]
         )

examples/use_with_langchain.py

@@ -37,7 +37,7 @@ def main():
 
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
         )
 
         # Create an agent with Pica tools

examples/use_with_langchain_github.py

@@ -32,7 +32,7 @@ def main():
 
         llm = ChatOpenAI(
             temperature=0,
-            model="gpt-4o",
+            model="gpt-4.1",
         )
 
         # Create an agent with Pica tools