@letta-ai/letta-client 1.0.0-alpha.6 → 1.0.0-alpha.7

package/src/resources/folders/files.ts

@@ -0,0 +1,295 @@
+// 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 { type Uploadable } from '../../core/uploads';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { multipartFormRequestOptions } from '../../internal/uploads';
+import { path } from '../../internal/utils/path';
+
+export class Files extends APIResource {
+  /**
+   * List paginated files associated with a data folder.
+   */
+  list(
+    folderID: string,
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FileListResponse> {
+    return this._client.get(path`/v1/folders/${folderID}/files`, { query, ...options });
+  }
+
+  /**
+   * Delete a file from a folder.
+   */
+  delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { folder_id } = params;
+    return this._client.delete(path`/v1/folders/${folder_id}/${fileID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Upload a file to a data folder.
+   */
+  upload(
+    folderID: string,
+    params: FileUploadParams,
+    options?: RequestOptions,
+  ): APIPromise<FileUploadResponse> {
+    const { duplicate_handling, name, ...body } = params;
+    return this._client.post(
+      path`/v1/folders/${folderID}/upload`,
+      multipartFormRequestOptions({ query: { duplicate_handling, name }, body, ...options }, this._client),
+    );
+  }
+}
+
+export type FileListResponse = Array<FileListResponse.FileListResponseItem>;
+
+export namespace FileListResponse {
+  /**
+   * Representation of a single FileMetadata
+   */
+  export interface FileListResponseItem {
+    /**
+     * The unique identifier of the source associated with the document.
+     */
+    source_id: string;
+
+    /**
+     * The human-friendly ID of the File
+     */
+    id?: string;
+
+    /**
+     * Number of chunks that have been embedded.
+     */
+    chunks_embedded?: number | null;
+
+    /**
+     * Optional full-text content of the file; only populated on demand due to its
+     * size.
+     */
+    content?: string | null;
+
+    /**
+     * The creation date of the file.
+     */
+    created_at?: string | null;
+
+    /**
+     * Optional error message if the file failed processing.
+     */
+    error_message?: string | null;
+
+    /**
+     * The creation date of the file.
+     */
+    file_creation_date?: string | null;
+
+    /**
+     * The last modified date of the file.
+     */
+    file_last_modified_date?: string | null;
+
+    /**
+     * The name of the file.
+     */
+    file_name?: string | null;
+
+    /**
+     * The path to the file.
+     */
+    file_path?: string | null;
+
+    /**
+     * The size of the file in bytes.
+     */
+    file_size?: number | null;
+
+    /**
+     * The type of the file (MIME type).
+     */
+    file_type?: string | null;
+
+    /**
+     * The original name of the file as uploaded.
+     */
+    original_file_name?: string | null;
+
+    /**
+     * The current processing status of the file (e.g. pending, parsing, embedding,
+     * completed, error).
+     */
+    processing_status?: 'pending' | 'parsing' | 'embedding' | 'completed' | 'error';
+
+    /**
+     * Total number of chunks for the file.
+     */
+    total_chunks?: number | null;
+
+    /**
+     * The update date of the file.
+     */
+    updated_at?: string | null;
+  }
+}
+
+/**
+ * Representation of a single FileMetadata
+ */
+export interface FileUploadResponse {
+  /**
+   * The unique identifier of the source associated with the document.
+   */
+  source_id: string;
+
+  /**
+   * The human-friendly ID of the File
+   */
+  id?: string;
+
+  /**
+   * Number of chunks that have been embedded.
+   */
+  chunks_embedded?: number | null;
+
+  /**
+   * Optional full-text content of the file; only populated on demand due to its
+   * size.
+   */
+  content?: string | null;
+
+  /**
+   * The creation date of the file.
+   */
+  created_at?: string | null;
+
+  /**
+   * Optional error message if the file failed processing.
+   */
+  error_message?: string | null;
+
+  /**
+   * The creation date of the file.
+   */
+  file_creation_date?: string | null;
+
+  /**
+   * The last modified date of the file.
+   */
+  file_last_modified_date?: string | null;
+
+  /**
+   * The name of the file.
+   */
+  file_name?: string | null;
+
+  /**
+   * The path to the file.
+   */
+  file_path?: string | null;
+
+  /**
+   * The size of the file in bytes.
+   */
+  file_size?: number | null;
+
+  /**
+   * The type of the file (MIME type).
+   */
+  file_type?: string | null;
+
+  /**
+   * The original name of the file as uploaded.
+   */
+  original_file_name?: string | null;
+
+  /**
+   * The current processing status of the file (e.g. pending, parsing, embedding,
+   * completed, error).
+   */
+  processing_status?: 'pending' | 'parsing' | 'embedding' | 'completed' | 'error';
+
+  /**
+   * Total number of chunks for the file.
+   */
+  total_chunks?: number | null;
+
+  /**
+   * The update date of the file.
+   */
+  updated_at?: string | null;
+}
+
+export interface FileListParams {
+  /**
+   * File ID cursor for pagination. Returns files that come after this file ID in the
+   * specified sort order
+   */
+  after?: string | null;
+
+  /**
+   * File ID cursor for pagination. Returns files that come before this file ID in
+   * the specified sort order
+   */
+  before?: string | null;
+
+  /**
+   * Whether to include full file content
+   */
+  include_content?: boolean;
+
+  /**
+   * Maximum number of files to return
+   */
+  limit?: number | null;
+
+  /**
+   * Sort order for files by creation time. 'asc' for oldest first, 'desc' for newest
+   * first
+   */
+  order?: 'asc' | 'desc';
+
+  /**
+   * Field to sort by
+   */
+  order_by?: 'created_at';
+}
+
+export interface FileDeleteParams {
+  /**
+   * The ID of the source in the format 'source-<uuid4>'
+   */
+  folder_id: string;
+}
+
+export interface FileUploadParams {
+  /**
+   * Body param:
+   */
+  file: Uploadable;
+
+  /**
+   * Query param: How to handle duplicate filenames
+   */
+  duplicate_handling?: 'skip' | 'error' | 'suffix' | 'replace';
+
+  /**
+   * Query param: Optional custom name to override the uploaded file's name
+   */
+  name?: string | null;
+}
+
+export declare namespace Files {
+  export {
+    type FileListResponse as FileListResponse,
+    type FileUploadResponse as FileUploadResponse,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileUploadParams as FileUploadParams,
+  };
+}

package/src/resources/folders/folders.ts

@@ -0,0 +1,264 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AgentsAPI from './agents';
+import { AgentListParams, AgentListResponse, Agents } from './agents';
+import * as FilesAPI from './files';
+import {
+  FileDeleteParams,
+  FileListParams,
+  FileListResponse,
+  FileUploadParams,
+  FileUploadResponse,
+  Files,
+} from './files';
+import * as ModelsAPI from '../models/models';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Folders extends APIResource {
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+  agents: AgentsAPI.Agents = new AgentsAPI.Agents(this._client);
+
+  /**
+   * Create a new data folder.
+   */
+  create(body: FolderCreateParams, options?: RequestOptions): APIPromise<Folder> {
+    return this._client.post('/v1/folders/', { body, ...options });
+  }
+
+  /**
+   * Get a folder by ID
+   */
+  retrieve(folderID: string, options?: RequestOptions): APIPromise<Folder> {
+    return this._client.get(path`/v1/folders/${folderID}`, options);
+  }
+
+  /**
+   * Update the name or documentation of an existing data folder.
+   */
+  update(folderID: string, body: FolderUpdateParams, options?: RequestOptions): APIPromise<Folder> {
+    return this._client.patch(path`/v1/folders/${folderID}`, { body, ...options });
+  }
+
+  /**
+   * List all data folders created by a user.
+   */
+  list(
+    query: FolderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FolderListResponse> {
+    return this._client.get('/v1/folders/', { query, ...options });
+  }
+
+  /**
+   * Delete a data folder.
+   */
+  delete(folderID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/v1/folders/${folderID}`, options);
+  }
+
+  /**
+   * Count all data folders created by a user.
+   */
+  count(options?: RequestOptions): APIPromise<FolderCountResponse> {
+    return this._client.get('/v1/folders/count', options);
+  }
+}
+
+/**
+ * Representation of a folder, which is a collection of files and passages.
+ *
+ * Parameters: id (str): The ID of the folder name (str): The name of the folder.
+ * embedding_config (EmbeddingConfig): The embedding configuration used by the
+ * folder. user_id (str): The ID of the user that created the folder. metadata
+ * (dict): Metadata associated with the folder. description (str): The description
+ * of the folder.
+ */
+export interface Folder {
+  /**
+   * The embedding configuration used by the folder.
+   */
+  embedding_config: ModelsAPI.EmbeddingConfig;
+
+  /**
+   * The name of the folder.
+   */
+  name: string;
+
+  /**
+   * The human-friendly ID of the Source
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the folder was created.
+   */
+  created_at?: string | null;
+
+  /**
+   * The id of the user that made this Tool.
+   */
+  created_by_id?: string | null;
+
+  /**
+   * The description of the folder.
+   */
+  description?: string | null;
+
+  /**
+   * Instructions for how to use the folder.
+   */
+  instructions?: string | null;
+
+  /**
+   * The id of the user that made this Tool.
+   */
+  last_updated_by_id?: string | null;
+
+  /**
+   * Metadata associated with the folder.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * The timestamp when the folder was last updated.
+   */
+  updated_at?: string | null;
+}
+
+export type FolderListResponse = Array<Folder>;
+
+export type FolderDeleteResponse = unknown;
+
+export type FolderCountResponse = number;
+
+export interface FolderCreateParams {
+  /**
+   * The name of the source.
+   */
+  name: string;
+
+  /**
+   * The description of the source.
+   */
+  description?: string | null;
+
+  /**
+   * The handle for the embedding config used by the source.
+   */
+  embedding?: string | null;
+
+  /**
+   * The chunk size of the embedding.
+   */
+  embedding_chunk_size?: number | null;
+
+  /**
+   * Configuration for embedding model connection and processing parameters.
+   */
+  embedding_config?: ModelsAPI.EmbeddingConfig | null;
+
+  /**
+   * Instructions for how to use the source.
+   */
+  instructions?: string | null;
+
+  /**
+   * Metadata associated with the source.
+   */
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export interface FolderUpdateParams {
+  /**
+   * The description of the source.
+   */
+  description?: string | null;
+
+  /**
+   * Configuration for embedding model connection and processing parameters.
+   */
+  embedding_config?: ModelsAPI.EmbeddingConfig | null;
+
+  /**
+   * Instructions for how to use the source.
+   */
+  instructions?: string | null;
+
+  /**
+   * Metadata associated with the source.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * The name of the source.
+   */
+  name?: string | null;
+}
+
+export interface FolderListParams {
+  /**
+   * Folder ID cursor for pagination. Returns folders that come after this folder ID
+   * in the specified sort order
+   */
+  after?: string | null;
+
+  /**
+   * Folder ID cursor for pagination. Returns folders that come before this folder ID
+   * in the specified sort order
+   */
+  before?: string | null;
+
+  /**
+   * Maximum number of folders to return
+   */
+  limit?: number | null;
+
+  /**
+   * Folder name to filter by
+   */
+  name?: string | null;
+
+  /**
+   * Sort order for folders by creation time. 'asc' for oldest first, 'desc' for
+   * newest first
+   */
+  order?: 'asc' | 'desc';
+
+  /**
+   * Field to sort by
+   */
+  order_by?: 'created_at';
+}
+
+Folders.Files = Files;
+Folders.Agents = Agents;
+
+export declare namespace Folders {
+  export {
+    type Folder as Folder,
+    type FolderListResponse as FolderListResponse,
+    type FolderDeleteResponse as FolderDeleteResponse,
+    type FolderCountResponse as FolderCountResponse,
+    type FolderCreateParams as FolderCreateParams,
+    type FolderUpdateParams as FolderUpdateParams,
+    type FolderListParams as FolderListParams,
+  };
+
+  export {
+    Files as Files,
+    type FileListResponse as FileListResponse,
+    type FileUploadResponse as FileUploadResponse,
+    type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
+    type FileUploadParams as FileUploadParams,
+  };
+
+  export {
+    Agents as Agents,
+    type AgentListResponse as AgentListResponse,
+    type AgentListParams as AgentListParams,
+  };
+}

package/src/resources/folders/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Agents, type AgentListResponse, type AgentListParams } from './agents';
+export {
+  Files,
+  type FileListResponse,
+  type FileUploadResponse,
+  type FileListParams,
+  type FileDeleteParams,
+  type FileUploadParams,
+} from './files';
+export {
+  Folders,
+  type Folder,
+  type FolderListResponse,
+  type FolderDeleteResponse,
+  type FolderCountResponse,
+  type FolderCreateParams,
+  type FolderUpdateParams,
+  type FolderListParams,
+} from './folders';