@letta-ai/letta-client 1.0.0-alpha.2 → 1.0.0-alpha.20

package/src/resources/steps/steps.ts

@@ -0,0 +1,293 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as MessagesAPI from '../agents/messages';
+import * as RunsAPI from '../runs/runs';
+import * as FeedbackAPI from './feedback';
+import { Feedback, FeedbackCreateParams } from './feedback';
+import * as StepsMessagesAPI from './messages';
+import { MessageListParams, MessageListResponse, MessageListResponsesArrayPage, Messages } from './messages';
+import * as MetricsAPI from './metrics';
+import { MetricRetrieveResponse, Metrics } from './metrics';
+import * as TraceAPI from './trace';
+import { Trace } from './trace';
+import { APIPromise } from '../../core/api-promise';
+import { ArrayPage, type ArrayPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Steps extends APIResource {
+  metrics: MetricsAPI.Metrics = new MetricsAPI.Metrics(this._client);
+  trace: TraceAPI.Trace = new TraceAPI.Trace(this._client);
+  feedback: FeedbackAPI.Feedback = new FeedbackAPI.Feedback(this._client);
+  messages: StepsMessagesAPI.Messages = new StepsMessagesAPI.Messages(this._client);
+
+  /**
+   * Get a step by ID.
+   */
+  retrieve(stepID: string, options?: RequestOptions): APIPromise<Step> {
+    return this._client.get(path`/v1/steps/${stepID}`, options);
+  }
+
+  /**
+   * List steps with optional pagination and date filters.
+   */
+  list(
+    query: StepListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<StepsArrayPage, Step> {
+    return this._client.getAPIList('/v1/steps/', ArrayPage<Step>, { query, ...options });
+  }
+}
+
+export type StepsArrayPage = ArrayPage<Step>;
+
+/**
+ * Letta's internal representation of a provider trace.
+ *
+ * Attributes: id (str): The unique identifier of the provider trace. request_json
+ * (Dict[str, Any]): JSON content of the provider request. response_json (Dict[str,
+ * Any]): JSON content of the provider response. step_id (str): ID of the step that
+ * this trace is associated with. organization_id (str): The unique identifier of
+ * the organization. created_at (datetime): The timestamp when the object was
+ * created.
+ */
+export interface ProviderTrace {
+  /**
+   * JSON content of the provider request
+   */
+  request_json: { [key: string]: unknown };
+
+  /**
+   * JSON content of the provider response
+   */
+  response_json: { [key: string]: unknown };
+
+  /**
+   * The human-friendly ID of the Provider_trace
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the object was created.
+   */
+  created_at?: string;
+
+  /**
+   * The id of the user that made this object.
+   */
+  created_by_id?: string | null;
+
+  /**
+   * The id of the user that made this object.
+   */
+  last_updated_by_id?: string | null;
+
+  /**
+   * ID of the step that this trace is associated with
+   */
+  step_id?: string | null;
+
+  /**
+   * The timestamp when the object was last updated.
+   */
+  updated_at?: string | null;
+}
+
+export interface Step {
+  /**
+   * The id of the step. Assigned by the database.
+   */
+  id: string;
+
+  /**
+   * The ID of the agent that performed the step.
+   */
+  agent_id?: string | null;
+
+  /**
+   * The number of tokens generated by the agent during this step.
+   */
+  completion_tokens?: number | null;
+
+  /**
+   * Metadata for the agent.
+   */
+  completion_tokens_details?: { [key: string]: unknown } | null;
+
+  /**
+   * The context window limit configured for this step.
+   */
+  context_window_limit?: number | null;
+
+  /**
+   * Error details including message, traceback, and additional context
+   */
+  error_data?: { [key: string]: unknown } | null;
+
+  /**
+   * The type/class of the error that occurred
+   */
+  error_type?: string | null;
+
+  /**
+   * The feedback for this step. Must be either 'positive' or 'negative'.
+   */
+  feedback?: 'positive' | 'negative' | null;
+
+  /**
+   * @deprecated The messages generated during this step. Deprecated: use
+   * `GET /v1/steps/{step_id}/messages` endpoint instead
+   */
+  messages?: Array<MessagesAPI.InternalMessage>;
+
+  /**
+   * The name of the model used for this step.
+   */
+  model?: string | null;
+
+  /**
+   * The model endpoint url used for this step.
+   */
+  model_endpoint?: string | null;
+
+  /**
+   * The surface that this agent step was initiated from.
+   */
+  origin?: string | null;
+
+  /**
+   * The project that the agent that executed this step belongs to (cloud only).
+   */
+  project_id?: string | null;
+
+  /**
+   * The number of tokens in the prompt during this step.
+   */
+  prompt_tokens?: number | null;
+
+  /**
+   * The category of the provider used for this step.
+   */
+  provider_category?: string | null;
+
+  /**
+   * The unique identifier of the provider that was configured for this step
+   */
+  provider_id?: string | null;
+
+  /**
+   * The name of the provider used for this step.
+   */
+  provider_name?: string | null;
+
+  /**
+   * The unique identifier of the run that this step belongs to. Only included for
+   * async calls.
+   */
+  run_id?: string | null;
+
+  /**
+   * Status of a step execution
+   */
+  status?: 'pending' | 'success' | 'failed' | 'cancelled' | null;
+
+  /**
+   * The stop reason associated with the step.
+   */
+  stop_reason?: RunsAPI.StopReasonType | null;
+
+  /**
+   * Metadata tags.
+   */
+  tags?: Array<string>;
+
+  /**
+   * The unique identifier of the transaction that processed this step.
+   */
+  tid?: string | null;
+
+  /**
+   * The total number of tokens processed by the agent during this step.
+   */
+  total_tokens?: number | null;
+
+  /**
+   * The trace id of the agent step.
+   */
+  trace_id?: string | null;
+}
+
+export interface StepListParams extends ArrayPageParams {
+  /**
+   * Filter by the ID of the agent that performed the step
+   */
+  agent_id?: string | null;
+
+  /**
+   * Return steps before this ISO datetime (e.g. "2025-01-29T15:01:19-08:00")
+   */
+  end_date?: string | null;
+
+  /**
+   * Filter by feedback
+   */
+  feedback?: 'positive' | 'negative' | null;
+
+  /**
+   * Filter by whether steps have feedback (true) or not (false)
+   */
+  has_feedback?: boolean | null;
+
+  /**
+   * Filter by the name of the model used for the step
+   */
+  model?: string | null;
+
+  /**
+   * Filter by the project ID that is associated with the step (cloud only).
+   */
+  project_id?: string | null;
+
+  /**
+   * Return steps after this ISO datetime (e.g. "2025-01-29T15:01:19-08:00")
+   */
+  start_date?: string | null;
+
+  /**
+   * Filter by tags
+   */
+  tags?: Array<string> | null;
+
+  /**
+   * Filter by trace ids returned by the server
+   */
+  trace_ids?: Array<string> | null;
+}
+
+Steps.Metrics = Metrics;
+Steps.Trace = Trace;
+Steps.Feedback = Feedback;
+Steps.Messages = Messages;
+
+export declare namespace Steps {
+  export {
+    type ProviderTrace as ProviderTrace,
+    type Step as Step,
+    type StepsArrayPage as StepsArrayPage,
+    type StepListParams as StepListParams,
+  };
+
+  export { Metrics as Metrics, type MetricRetrieveResponse as MetricRetrieveResponse };
+
+  export { Trace as Trace };
+
+  export { Feedback as Feedback, type FeedbackCreateParams as FeedbackCreateParams };
+
+  export {
+    Messages as Messages,
+    type MessageListResponse as MessageListResponse,
+    type MessageListResponsesArrayPage as MessageListResponsesArrayPage,
+    type MessageListParams as MessageListParams,
+  };
+}

package/src/resources/steps/trace.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as StepsAPI from './steps';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Trace extends APIResource {
+  /**
+   * Retrieve Trace For Step
+   */
+  retrieve(stepID: string, options?: RequestOptions): APIPromise<StepsAPI.ProviderTrace | null> {
+    return this._client.get(path`/v1/steps/${stepID}/trace`, options);
+  }
+}

package/src/resources/steps.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './steps/index';

package/src/resources/tags.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Tags extends APIResource {
+  /**
+   * Get the list of all agent tags that have been created.
+   */
+  list(query: TagListParams | null | undefined = {}, options?: RequestOptions): APIPromise<TagListResponse> {
+    return this._client.get('/v1/tags/', { query, ...options });
+  }
+}
+
+export type TagListResponse = Array<string>;
+
+export interface TagListParams {
+  /**
+   * Tag cursor for pagination. Returns tags that come after this tag in the
+   * specified sort order
+   */
+  after?: string | null;
+
+  /**
+   * Tag cursor for pagination. Returns tags that come before this tag in the
+   * specified sort order
+   */
+  before?: string | null;
+
+  /**
+   * Maximum number of tags to return
+   */
+  limit?: number | null;
+
+  /**
+   * Filter tags by name
+   */
+  name?: string | null;
+
+  /**
+   * Sort order for tags. 'asc' for alphabetical order, 'desc' for reverse
+   * alphabetical order
+   */
+  order?: 'asc' | 'desc';
+
+  /**
+   * Field to sort by
+   */
+  order_by?: 'name';
+
+  /**
+   * @deprecated Filter tags by text search. Deprecated, please use name field
+   * instead
+   */
+  query_text?: string | null;
+}
+
+export declare namespace Tags {
+  export { type TagListResponse as TagListResponse, type TagListParams as TagListParams };
+}

package/src/resources/templates/agents.ts

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Agents extends APIResource {
+  /**
+   * Creates an Agent or multiple Agents from a template
+   */
+  create(
+    templateVersion: string,
+    body: AgentCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(path`/v1/templates/${templateVersion}/agents`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface AgentCreateParams {
+  /**
+   * The name of the agent, optional otherwise a random one will be assigned
+   */
+  agent_name?: string;
+
+  /**
+   * The identity ids to assign to the agent
+   */
+  identity_ids?: Array<string>;
+
+  /**
+   * Set an initial sequence of messages, if not provided, the agent will start with
+   * the default message sequence, if an empty array is provided, the agent will
+   * start with no messages
+   */
+  initial_message_sequence?: Array<AgentCreateParams.InitialMessageSequence>;
+
+  /**
+   * The memory variables to assign to the agent
+   */
+  memory_variables?: { [key: string]: string };
+
+  /**
+   * The tags to assign to the agent
+   */
+  tags?: Array<string>;
+
+  /**
+   * The tool variables to assign to the agent
+   */
+  tool_variables?: { [key: string]: string };
+}
+
+export namespace AgentCreateParams {
+  export interface InitialMessageSequence {
+    content: string;
+
+    role: 'user' | 'system' | 'assistant';
+
+    batch_item_id?: string | null;
+
+    group_id?: string | null;
+
+    name?: string | null;
+
+    otid?: string | null;
+
+    sender_id?: string | null;
+  }
+}
+
+export declare namespace Agents {
+  export { type AgentCreateParams as AgentCreateParams };
+}

package/src/resources/templates/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Agents, type AgentCreateParams } from './agents';
+export { Templates } from './templates';

package/src/resources/templates/templates.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AgentsAPI from './agents';
+import { AgentCreateParams, Agents } from './agents';
+
+export class Templates extends APIResource {
+  agents: AgentsAPI.Agents = new AgentsAPI.Agents(this._client);
+}
+
+Templates.Agents = Agents;
+
+export declare namespace Templates {
+  export { Agents as Agents, type AgentCreateParams as AgentCreateParams };
+}

package/src/resources/templates.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './templates/index';