@llamaindex/llama-cloud 0.14.1

package/resources/files.d.mts

@@ -0,0 +1,358 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { type Uploadable } from "../core/uploads.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Files extends APIResource {
+    /**
+     * Upload a file using multipart/form-data.
+     */
+    create(params: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse>;
+    /**
+     * Delete a single file from the project.
+     *
+     * Args: file_id: The ID of the file to delete project: Validated project from
+     * dependency db: Database session
+     *
+     * Returns: None (204 No Content on success)
+     */
+    delete(fileID: string, params?: FileDeleteParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Returns a presigned url to read the file content.
+     */
+    get(fileID: string, query?: FileGetParams | null | undefined, options?: RequestOptions): APIPromise<PresignedURL>;
+    /**
+     * Query files with flexible filtering and pagination.
+     *
+     * **Deprecated**: Use GET /files instead for listing files with query parameters.
+     *
+     * Args: request: The query request with filters and pagination project: Validated
+     * project from dependency db: Database session
+     *
+     * Returns: Paginated response with files
+     *
+     * @deprecated
+     */
+    query(params: FileQueryParams, options?: RequestOptions): APIPromise<FileQueryResponse>;
+}
+/**
+ * Schema for a file.
+ */
+export interface File {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    name: string;
+    /**
+     * The ID of the project that the file belongs to
+     */
+    project_id: string;
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+    /**
+     * The ID of the data source that the file belongs to
+     */
+    data_source_id?: string | null;
+    /**
+     * The expiration date for the file. Files past this date can be deleted.
+     */
+    expires_at?: string | null;
+    /**
+     * The ID of the file in the external system
+     */
+    external_file_id?: string | null;
+    /**
+     * Size of the file in bytes
+     */
+    file_size?: number | null;
+    /**
+     * File type (e.g. pdf, docx, etc.)
+     */
+    file_type?: string | null;
+    /**
+     * The last modified time of the file
+     */
+    last_modified_at?: string | null;
+    /**
+     * Permission information for the file
+     */
+    permission_info?: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | null;
+    /**
+     * The intended purpose of the file (e.g., 'user_data', 'parse', 'extract',
+     * 'split', 'classify')
+     */
+    purpose?: string | null;
+    /**
+     * Resource information for the file
+     */
+    resource_info?: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | null;
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+}
+/**
+ * Schema for creating a file.
+ */
+export interface FileCreate {
+    /**
+     * Name that will be used for created file. If possible, always include the file
+     * extension in the name.
+     */
+    name: string;
+    /**
+     * The ID of the data source that the file belongs to
+     */
+    data_source_id?: string | null;
+    /**
+     * The ID of the file in the external system
+     */
+    external_file_id?: string | null;
+    /**
+     * Size of the file in bytes
+     */
+    file_size?: number | null;
+    /**
+     * The last modified time of the file
+     */
+    last_modified_at?: string | null;
+    /**
+     * Permission information for the file
+     */
+    permission_info?: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | null;
+    /**
+     * Resource information for the file
+     */
+    resource_info?: {
+        [key: string]: {
+            [key: string]: unknown;
+        } | Array<unknown> | string | number | boolean | null;
+    } | null;
+    /**
+     * Storage type for the file. Valid values: 'Ephemeral', 'Permanent' (no
+     * expiration). If not specified, defaults to permanent storage.
+     */
+    storage_type?: 'ephemeral' | 'permanent' | (string & {});
+}
+/**
+ * Schema for a presigned URL.
+ */
+export interface PresignedURL {
+    /**
+     * The time at which the presigned URL expires
+     */
+    expires_at: string;
+    /**
+     * A presigned URL for IO operations against a private file
+     */
+    url: string;
+    /**
+     * Form fields for a presigned POST request
+     */
+    form_fields?: {
+        [key: string]: string;
+    } | null;
+}
+/**
+ * Schema for a file in the v2 API.
+ */
+export interface FileCreateResponse {
+    /**
+     * Unique identifier
+     */
+    id: string;
+    name: string;
+    /**
+     * The ID of the project that the file belongs to
+     */
+    project_id: string;
+    /**
+     * The expiration date for the file. Files past this date can be deleted.
+     */
+    expires_at?: string | null;
+    /**
+     * The ID of the file in the external system
+     */
+    external_file_id?: string | null;
+    /**
+     * File type (e.g. pdf, docx, etc.)
+     */
+    file_type?: string | null;
+    /**
+     * The last modified time of the file
+     */
+    last_modified_at?: string | null;
+    /**
+     * The intended purpose of the file (e.g., 'user_data', 'parse', 'extract',
+     * 'split', 'classify', 'sheet')
+     */
+    purpose?: string | null;
+}
+/**
+ * Response schema for paginated file queries in V2 API.
+ */
+export interface FileQueryResponse {
+    /**
+     * The list of items.
+     */
+    items: Array<FileQueryResponse.Item>;
+    /**
+     * A token, which can be sent as page_token to retrieve the next page. If this
+     * field is omitted, there are no subsequent pages.
+     */
+    next_page_token?: string | null;
+    /**
+     * The total number of items available. This is only populated when specifically
+     * requested. The value may be an estimate and can be used for display purposes
+     * only.
+     */
+    total_size?: number | null;
+}
+export declare namespace FileQueryResponse {
+    /**
+     * Schema for a file in the v2 API.
+     */
+    interface Item {
+        /**
+         * Unique identifier
+         */
+        id: string;
+        name: string;
+        /**
+         * The ID of the project that the file belongs to
+         */
+        project_id: string;
+        /**
+         * The expiration date for the file. Files past this date can be deleted.
+         */
+        expires_at?: string | null;
+        /**
+         * The ID of the file in the external system
+         */
+        external_file_id?: string | null;
+        /**
+         * File type (e.g. pdf, docx, etc.)
+         */
+        file_type?: string | null;
+        /**
+         * The last modified time of the file
+         */
+        last_modified_at?: string | null;
+        /**
+         * The intended purpose of the file (e.g., 'user_data', 'parse', 'extract',
+         * 'split', 'classify', 'sheet')
+         */
+        purpose?: string | null;
+    }
+}
+export interface FileCreateParams {
+    /**
+     * Body param: The file to upload
+     */
+    file: Uploadable;
+    /**
+     * Body param: The intended purpose of the file. Valid values: 'user_data',
+     * 'parse', 'extract', 'split', 'classify', 'sheet'
+     */
+    purpose: string;
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: The ID of the file in the external system
+     */
+    external_file_id?: string | null;
+}
+export interface FileDeleteParams {
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface FileGetParams {
+    expires_at_seconds?: number | null;
+    organization_id?: string | null;
+    project_id?: string | null;
+}
+export interface FileQueryParams {
+    /**
+     * Query param
+     */
+    organization_id?: string | null;
+    /**
+     * Query param
+     */
+    project_id?: string | null;
+    /**
+     * Body param: Filter parameters for file queries.
+     */
+    filter?: FileQueryParams.Filter | null;
+    /**
+     * Body param: A comma-separated list of fields to order by, sorted in ascending
+     * order. Use 'field_name desc' to specify descending order.
+     */
+    order_by?: string | null;
+    /**
+     * Body param: The maximum number of items to return. The service may return fewer
+     * than this value. If unspecified, a default page size will be used. The maximum
+     * value is typically 1000; values above this will be coerced to the maximum.
+     */
+    page_size?: number | null;
+    /**
+     * Body param: A page token, received from a previous list call. Provide this to
+     * retrieve the subsequent page.
+     */
+    page_token?: string | null;
+}
+export declare namespace FileQueryParams {
+    /**
+     * Filter parameters for file queries.
+     */
+    interface Filter {
+        /**
+         * Filter by data source ID
+         */
+        data_source_id?: string | null;
+        /**
+         * Filter by external file ID
+         */
+        external_file_id?: string | null;
+        /**
+         * Filter by specific file IDs
+         */
+        file_ids?: Array<string> | null;
+        /**
+         * Filter by file name
+         */
+        file_name?: string | null;
+        /**
+         * Filter only manually uploaded files (data_source_id is null)
+         */
+        only_manually_uploaded?: boolean | null;
+        /**
+         * Filter by project ID
+         */
+        project_id?: string | null;
+    }
+}
+export declare namespace Files {
+    export { type File as File, type FileCreate as FileCreate, type PresignedURL as PresignedURL, type FileCreateResponse as FileCreateResponse, type FileQueryResponse as FileQueryResponse, type FileCreateParams as FileCreateParams, type FileDeleteParams as FileDeleteParams, type FileGetParams as FileGetParams, type FileQueryParams as FileQueryParams, };
+}
+//# sourceMappingURL=files.d.mts.map

package/resources/files.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OAEnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAQ1F;;;;;;;OAOG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;OAEG;IACH,GAAG,CACD,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAQxF;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;KAC/F,GAAG,IAAI,CAAC;IAET;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE;QACd,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;KAC/F,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;KAC/F,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,CAAC,EAAE;QACd,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;KAC/F,GAAG,IAAI,CAAC;IAET;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAErC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAExC;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}