Refactor agent fields in llama_cloud_services (#921)

py/llama_cloud_services/beta/agent_data/client.py

@@ -86,7 +86,7 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
             client=llama_client,
             type=ExtractedPerson,
             collection="extracted_people",
-            agent_url_id="person-extraction-agent"
+            deployment_name="person-extraction-agent"
         )
 
         # Create data
@@ -109,10 +109,12 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
         self,
         type: Type[AgentDataT],
         collection: str = "default",
-        agent_url_id: Optional[str] = None,
+        deployment_name: Optional[str] = None,
         client: Optional[AsyncLlamaCloud] = None,
         token: Optional[str] = None,
         base_url: Optional[str] = None,
+        # deprecated, use deployment_name instead
+        agent_url_id: Optional[str] = None,
     ):
         """
         Initialize the AsyncAgentDataClient.
@@ -123,11 +125,11 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
             collection: Named collection within the agent for organizing data.
                 Defaults to "default". Collections allow logical separation of
                 different data types or workflows within the same agent.
-            agent_url_id: Unique identifier for the agent. This normally appears in the
-                url of an agent within the llama cloud platform. If not provided,
-                will attempt to use the LLAMA_DEPLOY_DEPLOYMENT_NAME environment
-                variable. Data can only be added to an already existing agent in the
-                platform.
+            deployment_name: Unique identifier for the agent deployment. This normally
+                appears in the URL of an agent within the Llama Cloud platform. If not
+                provided, will attempt to use the LLAMA_DEPLOY_DEPLOYMENT_NAME
+                environment variable. Data can only be added to an already existing
+                agent in the platform.
             client: AsyncLlamaCloud client instance for API communication. If not provided, will
                 construct one from the provided api token and base url
             token: Llama Cloud API token. Reads from LLAMA_CLOUD_API_KEY if not provided
@@ -135,15 +137,14 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
                 defaults to https://api.cloud.llamaindex.ai
 
         Raises:
-            ValueError: If agent_url_id is not provided and the
+            ValueError: If deployment_name is not provided and the
                 LLAMA_DEPLOY_DEPLOYMENT_NAME environment variable is not set
 
         Note:
             The client automatically applies retry logic to all API calls with
             exponential backoff for timeout, connection, and HTTP status errors.
         """
-
-        self.agent_url_id = agent_url_id or get_default_agent_id()
+        self.deployment_name = deployment_name or agent_url_id or get_default_agent_id()
 
         self.collection = collection
         if not client:
@@ -164,7 +165,7 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
     @agent_data_retry
     async def create_item(self, data: AgentDataT) -> TypedAgentData[AgentDataT]:
         raw_data = await self.client.beta.create_agent_data(
-            agent_slug=self.agent_url_id,
+            deployment_name=self.deployment_name,
             collection=self.collection,
             data=data.model_dump(),
         )
@@ -211,7 +212,7 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
             include_total: Whether to include the total count in the response. Defaults to False to improve performance. It's recommended to only request on the first page.
         """
         raw = await self.client.beta.search_agent_data_api_v_1_beta_agent_data_search_post(
-            agent_slug=self.agent_url_id,
+            deployment_name=self.deployment_name,
             collection=self.collection,
             filter=filter,
             order_by=order_by,
@@ -254,7 +255,7 @@ class AsyncAgentDataClient(Generic[AgentDataT]):
             page_size: Maximum number of groups to return per page.
         """
         raw = await self.client.beta.aggregate_agent_data_api_v_1_beta_agent_data_aggregate_post(
-            agent_slug=self.agent_url_id,
+            deployment_name=self.deployment_name,
             collection=self.collection,
             page_size=page_size,
             filter=filter,

py/llama_cloud_services/beta/agent_data/schema.py

@@ -10,7 +10,7 @@ CRUD operations, search capabilities, filtering, and aggregation functionality
 for managing agent-generated data at scale.
 
 Key Concepts:
-- Agent Slug: Unique identifier for an agent instance
+- Deployment Name: Unique identifier for an agent deployment
 - Collection: Named grouping of data within an agent (defaults to "default"). Data within a collection should be of the same type.
 - Agent Data: Individual structured data records with metadata and timestamps
 
@@ -26,7 +26,7 @@ Example Usage:
         client=async_llama_cloud,
         type=Person,
         collection="people",
-        agent_url_id="my-extraction-agent-xyz"
+        deployment_name="my-extraction-agent-xyz"
     )
 
     # Create typed data
@@ -78,7 +78,7 @@ class TypedAgentData(BaseModel, Generic[AgentDataT]):
 
     Attributes:
         id: Unique identifier for this data record
-        agent_url_id: Identifier of the agent that created this data
+        deployment_name: Identifier of the agent deployment that created this data
         collection: Named collection within the agent (used for organization)
         data: The actual structured data payload (typed as AgentDataT)
         created_at: Timestamp when the record was first created
@@ -94,8 +94,8 @@ class TypedAgentData(BaseModel, Generic[AgentDataT]):
     """
 
     id: Optional[str] = Field(description="Unique identifier for this data record")
-    agent_url_id: str = Field(
-        description="Identifier of the agent that created this data"
+    deployment_name: str = Field(
+        description="Identifier of the agent deployment that created this data"
     )
     collection: Optional[str] = Field(
         description="Named collection within the agent for data organization"
@@ -124,7 +124,7 @@ class TypedAgentData(BaseModel, Generic[AgentDataT]):
 
         return cls(
             id=raw_data.id,
-            agent_url_id=raw_data.agent_slug,
+            deployment_name=raw_data.deployment_name,
             collection=raw_data.collection,
             data=data,
             created_at=raw_data.created_at,

py/llama_parse/pyproject.toml

@@ -11,13 +11,13 @@ dev = [
 
 [project]
 name = "llama-parse"
-version = "0.6.66"
+version = "0.6.67"
 description = "Parse files into RAG-Optimized formats."
 authors = [{name = "Logan Markewich", email = "logan@llamaindex.ai"}]
 requires-python = ">=3.9,<4.0"
 readme = "README.md"
 license = "MIT"
-dependencies = ["llama-cloud-services>=0.6.66"]
+dependencies = ["llama-cloud-services>=0.6.67"]
 
 [project.scripts]
 llama-parse = "llama_parse.cli.main:parse"

py/pyproject.toml

@@ -19,7 +19,7 @@ dev = [
 
 [project]
 name = "llama-cloud-services"
-version = "0.6.66"
+version = "0.6.67"
 description = "Tailored SDK clients for LlamaCloud services."
 authors = [{name = "Logan Markewich", email = "logan@runllama.ai"}]
 requires-python = ">=3.9,<4.0"
@@ -27,7 +27,7 @@ readme = "README.md"
 license = "MIT"
 dependencies = [
   "llama-index-core>=0.12.0",
-  "llama-cloud==0.1.41",
+  "llama-cloud==0.1.42",
   "pydantic>=2.8,!=2.10",
   "click>=8.1.7,<9",
   "python-dotenv>=1.0.1,<2",

py/tests/beta/agent_data/test_agent_data_client.py

@@ -68,7 +68,7 @@ async def test_agent_data_crud_operations():
         client=client,
         type=ExampleData,
         collection=f"test-collection-{test_id[:8]}",
-        agent_url_id=LLAMA_DEPLOY_DEPLOYMENT_NAME,
+        deployment_name=LLAMA_DEPLOY_DEPLOYMENT_NAME,
     )
 
     # Create test data

py/unit_tests/beta/agent/test_agent_data_schema.py

@@ -38,7 +38,7 @@ def test_typed_agent_data_from_raw():
     """Test TypedAgentData.from_raw class method."""
     raw_data = AgentData(
         id="456",
-        agent_slug="extraction-agent",
+        deployment_name="extraction-agent",
         collection="employees",
         data={"name": "Jane Smith", "age": 25, "email": "jane@company.com"},
         created_at=datetime.now(),
@@ -48,7 +48,7 @@ def test_typed_agent_data_from_raw():
     typed_data = TypedAgentData.from_raw(raw_data, Person)
 
     assert typed_data.id == "456"
-    assert typed_data.agent_url_id == "extraction-agent"
+    assert typed_data.deployment_name == "extraction-agent"
     assert typed_data.collection == "employees"
     assert typed_data.data.name == "Jane Smith"
     assert typed_data.data.age == 25
@@ -59,7 +59,7 @@ def test_typed_agent_data_from_raw_validation_error():
     """Test TypedAgentData.from_raw with invalid data."""
     raw_data = AgentData(
         id="789",
-        agent_slug="test-agent",
+        deployment_name="test-agent",
         collection="people",
         data={"name": "Invalid Person", "age": "not_a_number"},  # Invalid age
         created_at=datetime.now(),

py/uv.lock

@@ -1582,21 +1582,21 @@ wheels = [
 
 [[package]]
 name = "llama-cloud"
-version = "0.1.41"
+version = "0.1.42"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "certifi" },
     { name = "httpx" },
     { name = "pydantic" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/62/6c/b2e84eebed376aea34c446cab745da5fc4e9dc53309180672299083219d5/llama_cloud-0.1.41.tar.gz", hash = "sha256:dcb741b779e3e740cd64928cfffc8ef70ed0e9bae9ef26acbe1d7e32aa737bdc", size = 109854, upload-time = "2025-09-05T22:45:13.069Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/21/04/ae0694b582d6aab4d6e7957febb7bff048897ac231ad80ba1bd71547d944/llama_cloud-0.1.42.tar.gz", hash = "sha256:485aa0e364ea648e3aaa3b2c54af7bcb6f2242c50b4f86ec022e137413fff464", size = 112480, upload-time = "2025-09-16T20:25:42.631Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/1e/4d/f0af76b389310840ce3483a92560a152025b0eefe4eee0c81102bf3317e6/llama_cloud-0.1.41-py3-none-any.whl", hash = "sha256:c847f288f0d3f4b23f47345088006deae5f2cf3f223ac1819d4c1531e9aaa13e", size = 307646, upload-time = "2025-09-05T22:45:11.597Z" },
+    { url = "https://files.pythonhosted.org/packages/6a/61/85d115699a59d03f0783e119aaf6d534fca95dbe1a4531a8056e6a4774ed/llama_cloud-0.1.42-py3-none-any.whl", hash = "sha256:4ed3edde4a277ff52eeb831188c8476eb079b5e4605ad3142157a0f054b27d96", size = 311857, upload-time = "2025-09-16T20:25:41.479Z" },
 ]
 
 [[package]]
 name = "llama-cloud-services"
-version = "0.6.65"
+version = "0.6.66"
 source = { editable = "." }
 dependencies = [
     { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" },
@@ -1631,7 +1631,7 @@ dev = [
 requires-dist = [
     { name = "click", specifier = ">=8.1.7,<9" },
     { name = "eval-type-backport", marker = "python_full_version < '3.10'", specifier = ">=0.2.0,<0.3" },
-    { name = "llama-cloud", specifier = "==0.1.41" },
+    { name = "llama-cloud", specifier = "==0.1.42" },
     { name = "llama-index-core", specifier = ">=0.12.0" },
     { name = "packaging", specifier = ">=25.0" },
     { name = "platformdirs", specifier = ">=4.3.7,<5" },

ts/llama_cloud_services/package.json

@@ -1,6 +1,6 @@
 {
   "name": "llama-cloud-services",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "type": "module",
   "license": "MIT",
   "scripts": {

ts/llama_cloud_services/src/beta/agent/client.ts

@@ -25,20 +25,23 @@ import type {
 export class AgentClient<T = unknown> {
   private client: ReturnType<typeof createClient>;
   private collection: string;
-  private agentUrlId: string;
+  private deploymentName: string;
 
   constructor({
     client = defaultClient,
     collection = "default",
-    agentUrlId = "_public",
+    deploymentName = "_public",
+    agentUrlId,
   }: {
     client?: ReturnType<typeof createClient>;
     collection?: string;
+    deploymentName?: string;
+    // deprecated, use deploymentName instead
     agentUrlId?: string;
   }) {
     this.client = client;
     this.collection = collection;
-    this.agentUrlId = agentUrlId;
+    this.deploymentName = agentUrlId || deploymentName;
   }
 
   /**
@@ -48,7 +51,7 @@ export class AgentClient<T = unknown> {
     const response = await createAgentDataApiV1BetaAgentDataPost({
       throwOnError: true,
       body: {
-        agent_slug: this.agentUrlId,
+        deployment_name: this.deploymentName,
         collection: this.collection,
         data: data as Record<string, unknown>,
       },
@@ -118,7 +121,7 @@ export class AgentClient<T = unknown> {
     const response = await searchAgentDataApiV1BetaAgentDataSearchPost({
       throwOnError: true,
       body: {
-        agent_slug: this.agentUrlId,
+        deployment_name: this.deploymentName,
         ...(this.collection !== undefined && {
           collection: this.collection,
         }),
@@ -165,7 +168,7 @@ export class AgentClient<T = unknown> {
     const response = await aggregateAgentDataApiV1BetaAgentDataAggregatePost({
       throwOnError: true,
       body: {
-        agent_slug: this.agentUrlId,
+        deployment_name: this.deploymentName,
         ...(this.collection !== undefined && {
           collection: this.collection,
         }),
@@ -209,7 +212,7 @@ export class AgentClient<T = unknown> {
   private transformResponse(data: AgentData): TypedAgentData<T> {
     const result: TypedAgentData<T> = {
       id: data.id!,
-      agentUrlId: data.agent_slug,
+      deploymentName: data.deployment_name,
       data: data.data as T,
       createdAt: new Date(data.created_at!),
       updatedAt: new Date(data.updated_at!),
@@ -250,10 +253,10 @@ export interface AgentDataClientOptions {
   /** Base URL for the client */
   /** Base URL of the llama cloud api */
   baseUrl?: string;
-  /** If running in an agent runtime, optionally provide the window url to infer the agent url id */
+  /** If running in an agent runtime, optionally provide the window url to infer the deployment name */
   windowUrl?: string;
-  /** Agent URL ID for the client, if not provided, it will be inferred from the window url, or fall back to "default" */
-  agentUrlId?: string;
+  /** Deployment name for the client, if not provided, it will be inferred from the window url, or fall back to "default" */
+  deploymentName?: string;
   /** Collection name for the client, defaults to "default" */
   collection?: string;
 }
@@ -267,22 +270,25 @@ export function createAgentDataClient<T = unknown>({
   client = defaultClient,
   windowUrl,
   env,
+  deploymentName,
   agentUrlId,
   collection = "default",
 }: {
   client?: ReturnType<typeof createClient>;
   windowUrl?: string;
   env?: Record<string, string>;
+  deploymentName?: string;
+  // deprecated, use deploymentName instead
   agentUrlId?: string;
   collection?: string;
 } = {}): AgentClient<T> {
-  if (env && !agentUrlId) {
-    agentUrlId =
+  if (env && !deploymentName) {
+    deploymentName =
       env.LLAMA_DEPLOY_DEPLOYMENT_NAME ||
       env.NEXT_PUBLIC_LLAMA_DEPLOY_DEPLOYMENT_NAME ||
       env.VITE_LLAMA_DEPLOY_DEPLOYMENT_NAME;
   }
-  if (windowUrl && !agentUrlId) {
+  if (windowUrl && !deploymentName) {
     try {
       const url = new URL(windowUrl);
       const path = url.pathname;
@@ -291,17 +297,18 @@ export function createAgentDataClient<T = unknown>({
         url.hostname.includes("127.0.0.1");
       if (path.startsWith("/deployments/") && !isLocalhost) {
         // /deployments/<agent-url-id>/ui/ -> ["", "deployments", "<agent-url-id>", "ui"]
-        agentUrlId = path.split("/")[2];
+        deploymentName = path.split("/")[2];
       }
     } catch (error) {
       console.warn(
-        "Failed to infer agent url id from window url, falling back to default",
+        "Failed to infer deployment name from window url, falling back to default",
         error,
       );
     }
   }
 
   return new AgentClient({
+    ...(deploymentName && { deploymentName }),
     ...(agentUrlId && { agentUrlId }),
     collection,
     client,

ts/llama_cloud_services/src/beta/agent/types.ts

@@ -87,8 +87,8 @@ export interface ExtractedData<T = unknown> {
 export interface TypedAgentData<T = unknown> {
   /** The unique ID of the agent data record. */
   id: string;
-  /** The ID of the agent that created the data. */
-  agentUrlId: string;
+  /** The deployment name of the agent that created the data. */
+  deploymentName: string;
   /** The collection of the agent data. */
   collection?: string;
   /** The data of the agent data. Usually an ExtractedData&lt;SomeOtherType&gt; */