@llamaindex/llama-cloud 0.14.1

package/src/resources/classifier/jobs.ts

@@ -0,0 +1,386 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ParsingAPI from '../parsing';
+import { APIPromise } from '../../core/api-promise';
+import { PagePromise, PaginatedClassifyJobs, type PaginatedClassifyJobsParams } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { pollUntilComplete, PollingOptions } from '../../core/polling';
+
+export class Jobs extends APIResource {
+  /**
+   * Create a classify job. Experimental: This endpoint is not yet ready for
+   * production use and is subject to change at any time.
+   */
+  create(params: JobCreateParams, options?: RequestOptions): APIPromise<ClassifyJob> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/classifier/jobs', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List classify jobs. Experimental: This endpoint is not yet ready for production
+   * use and is subject to change at any time.
+   */
+  list(
+    query: JobListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ClassifyJobsPaginatedClassifyJobs, ClassifyJob> {
+    return this._client.getAPIList('/api/v1/classifier/jobs', PaginatedClassifyJobs<ClassifyJob>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get a classify job. Experimental: This endpoint is not yet ready for production
+   * use and is subject to change at any time.
+   */
+  get(
+    classifyJobID: string,
+    query: JobGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ClassifyJob> {
+    return this._client.get(path`/api/v1/classifier/jobs/${classifyJobID}`, { query, ...options });
+  }
+
+  /**
+   * Get the results of a classify job. Experimental: This endpoint is not yet ready
+   * for production use and is subject to change at any time.
+   */
+  getResults(
+    classifyJobID: string,
+    query: JobGetResultsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobGetResultsResponse> {
+    return this._client.get(path`/api/v1/classifier/jobs/${classifyJobID}/results`, { query, ...options });
+  }
+
+  /**
+   * Wait for a classify job to complete by polling until it reaches a terminal state.
+   *
+   * This method polls the job status at regular intervals until the job completes
+   * successfully or fails. It uses configurable backoff strategies to optimize
+   * polling behavior.
+   *
+   * @param classifyJobID - The ID of the classify job to wait for
+   * @param query - Query parameters for the get request
+   * @param options - Polling configuration options
+   * @returns The completed ClassifyJob
+   * @throws {PollingTimeoutError} If the job doesn't complete within the timeout period
+   * @throws {PollingError} If the job fails or is cancelled
+   *
+   * @example
+   * ```typescript
+   * import { LlamaCloud } from 'llama-cloud';
+   *
+   * const client = new LlamaCloud({ apiKey: '...' });
+   *
+   * // Create a classify job
+   * const job = await client.classifier.jobs.create({
+   *   file_ids: ['file1', 'file2'],
+   *   rules: [...]
+   * });
+   *
+   * // Wait for it to complete
+   * const completedJob = await client.classifier.jobs.waitForCompletion(
+   *   job.id,
+   *   {},
+   *   { verbose: true }
+   * );
+   *
+   * // Get the results
+   * const results = await client.classifier.jobs.getResults(job.id);
+   * ```
+   */
+  async waitForCompletion(
+    classifyJobID: string,
+    query: JobGetParams | null | undefined = {},
+    options?: PollingOptions & RequestOptions,
+  ): Promise<ClassifyJob> {
+    const { pollingInterval, maxInterval, timeout, backoff, verbose, ...requestOptions } = options || {};
+
+    const getStatus = async (): Promise<ClassifyJob> => {
+      return await this.get(classifyJobID, query, requestOptions);
+    };
+
+    const isComplete = (job: ClassifyJob): boolean => {
+      return job.status === 'SUCCESS' || job.status === 'PARTIAL_SUCCESS';
+    };
+
+    const isError = (job: ClassifyJob): boolean => {
+      return job.status === 'ERROR' || job.status === 'CANCELLED';
+    };
+
+    const getErrorMessage = (job: ClassifyJob): string => {
+      const errorParts = [`Job ${classifyJobID} failed with status: ${job.status}`];
+      if (job.error_message) {
+        errorParts.push(`Error: ${job.error_message}`);
+      }
+      return errorParts.join(' | ');
+    };
+
+    return await pollUntilComplete(getStatus, isComplete, isError, getErrorMessage, {
+      pollingInterval,
+      maxInterval,
+      timeout: timeout || 300.0, // Default to 300 seconds for classifier
+      backoff,
+      verbose,
+    });
+  }
+}
+
+export type ClassifyJobsPaginatedClassifyJobs = PaginatedClassifyJobs<ClassifyJob>;
+
+/**
+ * A rule for classifying documents - v0 simplified version.
+ *
+ * This represents a single classification rule that will be applied to documents.
+ * All rules are content-based and use natural language descriptions.
+ */
+export interface ClassifierRule {
+  /**
+   * Natural language description of what to classify. Be specific about the content
+   * characteristics that identify this document type.
+   */
+  description: string;
+
+  /**
+   * The document type to assign when this rule matches (e.g., 'invoice', 'receipt',
+   * 'contract')
+   */
+  type: string;
+}
+
+/**
+ * A classify job.
+ */
+export interface ClassifyJob {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * The ID of the project
+   */
+  project_id: string;
+
+  /**
+   * The rules to classify the files
+   */
+  rules: Array<ClassifierRule>;
+
+  /**
+   * The status of the classify job
+   */
+  status: ParsingAPI.StatusEnum;
+
+  /**
+   * The ID of the user
+   */
+  user_id: string;
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  effective_at?: string;
+
+  /**
+   * Error message for the latest job attempt, if any.
+   */
+  error_message?: string | null;
+
+  /**
+   * The job record ID associated with this status, if any.
+   */
+  job_record_id?: string | null;
+
+  /**
+   * The classification mode to use
+   */
+  mode?: 'FAST' | 'MULTIMODAL';
+
+  /**
+   * The configuration for the parsing job
+   */
+  parsing_configuration?: ClassifyParsingConfiguration;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+/**
+ * Parsing configuration for a classify job.
+ */
+export interface ClassifyParsingConfiguration {
+  /**
+   * The language to parse the files in
+   */
+  lang?: ParsingAPI.ParsingLanguages;
+
+  /**
+   * The maximum number of pages to parse
+   */
+  max_pages?: number | null;
+
+  /**
+   * The pages to target for parsing (0-indexed, so first page is at 0)
+   */
+  target_pages?: Array<number> | null;
+}
+
+/**
+ * Response model for the classify endpoint following AIP-132 pagination standard.
+ */
+export interface JobGetResultsResponse {
+  /**
+   * The list of items.
+   */
+  items: Array<JobGetResultsResponse.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 namespace JobGetResultsResponse {
+  /**
+   * A file classification.
+   */
+  export interface Item {
+    /**
+     * Unique identifier
+     */
+    id: string;
+
+    /**
+     * The ID of the classify job
+     */
+    classify_job_id: string;
+
+    /**
+     * Creation datetime
+     */
+    created_at?: string | null;
+
+    /**
+     * The ID of the classified file
+     */
+    file_id?: string | null;
+
+    /**
+     * Result of classifying a single file.
+     */
+    result?: Item.Result | null;
+
+    /**
+     * Update datetime
+     */
+    updated_at?: string | null;
+  }
+
+  export namespace Item {
+    /**
+     * Result of classifying a single file.
+     */
+    export interface Result {
+      /**
+       * Confidence score of the classification (0.0-1.0)
+       */
+      confidence: number;
+
+      /**
+       * Step-by-step explanation of why this classification was chosen and the
+       * confidence score assigned
+       */
+      reasoning: string;
+
+      /**
+       * The document type that best matches, or null if no match.
+       */
+      type: string | null;
+    }
+  }
+}
+
+export interface JobCreateParams {
+  /**
+   * Body param: The IDs of the files to classify
+   */
+  file_ids: Array<string>;
+
+  /**
+   * Body param: The rules to classify the files
+   */
+  rules: Array<ClassifierRule>;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: The classification mode to use
+   */
+  mode?: 'FAST' | 'MULTIMODAL';
+
+  /**
+   * Body param: The configuration for the parsing job
+   */
+  parsing_configuration?: ClassifyParsingConfiguration;
+}
+
+export interface JobListParams extends PaginatedClassifyJobsParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export interface JobGetParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export interface JobGetResultsParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace Jobs {
+  export {
+    type ClassifierRule as ClassifierRule,
+    type ClassifyJob as ClassifyJob,
+    type ClassifyParsingConfiguration as ClassifyParsingConfiguration,
+    type JobGetResultsResponse as JobGetResultsResponse,
+    type ClassifyJobsPaginatedClassifyJobs as ClassifyJobsPaginatedClassifyJobs,
+    type JobCreateParams as JobCreateParams,
+    type JobListParams as JobListParams,
+    type JobGetParams as JobGetParams,
+    type JobGetResultsParams as JobGetResultsParams,
+  };
+}

package/src/resources/classifier.ts

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

package/src/resources/data-sinks.ts

@@ -0,0 +1,174 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+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 DataSinks extends APIResource {
+  /**
+   * Create a new data sink.
+   */
+  create(params: DataSinkCreateParams, options?: RequestOptions): APIPromise<DataSink> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/data-sinks', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Update a data sink by ID.
+   */
+  update(dataSinkID: string, body: DataSinkUpdateParams, options?: RequestOptions): APIPromise<DataSink> {
+    return this._client.put(path`/api/v1/data-sinks/${dataSinkID}`, { body, ...options });
+  }
+
+  /**
+   * List data sinks for a given project.
+   */
+  list(
+    query: DataSinkListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DataSinkListResponse> {
+    return this._client.get('/api/v1/data-sinks', { query, ...options });
+  }
+
+  /**
+   * Delete a data sink by ID.
+   */
+  delete(dataSinkID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/data-sinks/${dataSinkID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a data sink by ID.
+   */
+  get(dataSinkID: string, options?: RequestOptions): APIPromise<DataSink> {
+    return this._client.get(path`/api/v1/data-sinks/${dataSinkID}`, options);
+  }
+}
+
+/**
+ * Schema for a data sink.
+ */
+export interface DataSink {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Component that implements the data sink
+   */
+  component:
+    | { [key: string]: unknown }
+    | Shared.CloudPineconeVectorStore
+    | Shared.CloudPostgresVectorStore
+    | Shared.CloudQdrantVectorStore
+    | Shared.CloudAzureAISearchVectorStore
+    | Shared.CloudMongoDBAtlasVectorSearch
+    | Shared.CloudMilvusVectorStore
+    | Shared.CloudAstraDBVectorStore;
+
+  /**
+   * The name of the data sink.
+   */
+  name: string;
+
+  project_id: string;
+
+  sink_type: 'PINECONE' | 'POSTGRES' | 'QDRANT' | 'AZUREAI_SEARCH' | 'MONGODB_ATLAS' | 'MILVUS' | 'ASTRA_DB';
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+}
+
+export type DataSinkListResponse = Array<DataSink>;
+
+export interface DataSinkCreateParams {
+  /**
+   * Body param: Component that implements the data sink
+   */
+  component:
+    | { [key: string]: unknown }
+    | Shared.CloudPineconeVectorStore
+    | Shared.CloudPostgresVectorStore
+    | Shared.CloudQdrantVectorStore
+    | Shared.CloudAzureAISearchVectorStore
+    | Shared.CloudMongoDBAtlasVectorSearch
+    | Shared.CloudMilvusVectorStore
+    | Shared.CloudAstraDBVectorStore;
+
+  /**
+   * Body param: The name of the data sink.
+   */
+  name: string;
+
+  /**
+   * Body param
+   */
+  sink_type: 'PINECONE' | 'POSTGRES' | 'QDRANT' | 'AZUREAI_SEARCH' | 'MONGODB_ATLAS' | 'MILVUS' | 'ASTRA_DB';
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+}
+
+export interface DataSinkUpdateParams {
+  sink_type: 'PINECONE' | 'POSTGRES' | 'QDRANT' | 'AZUREAI_SEARCH' | 'MONGODB_ATLAS' | 'MILVUS' | 'ASTRA_DB';
+
+  /**
+   * Component that implements the data sink
+   */
+  component?:
+    | { [key: string]: unknown }
+    | Shared.CloudPineconeVectorStore
+    | Shared.CloudPostgresVectorStore
+    | Shared.CloudQdrantVectorStore
+    | Shared.CloudAzureAISearchVectorStore
+    | Shared.CloudMongoDBAtlasVectorSearch
+    | Shared.CloudMilvusVectorStore
+    | Shared.CloudAstraDBVectorStore
+    | null;
+
+  /**
+   * The name of the data sink.
+   */
+  name?: string | null;
+}
+
+export interface DataSinkListParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace DataSinks {
+  export {
+    type DataSink as DataSink,
+    type DataSinkListResponse as DataSinkListResponse,
+    type DataSinkCreateParams as DataSinkCreateParams,
+    type DataSinkUpdateParams as DataSinkUpdateParams,
+    type DataSinkListParams as DataSinkListParams,
+  };
+}