@llamaindex/llama-cloud 0.14.1

package/src/resources/data-sources.ts

@@ -0,0 +1,256 @@
+// 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 DataSources extends APIResource {
+  /**
+   * Create a new data source.
+   */
+  create(params: DataSourceCreateParams, options?: RequestOptions): APIPromise<DataSource> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/data-sources', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Update a data source by ID.
+   */
+  update(
+    dataSourceID: string,
+    body: DataSourceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSource> {
+    return this._client.put(path`/api/v1/data-sources/${dataSourceID}`, { body, ...options });
+  }
+
+  /**
+   * List data sources for a given project. If project_id is not provided, uses the
+   * default project.
+   */
+  list(
+    query: DataSourceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DataSourceListResponse> {
+    return this._client.get('/api/v1/data-sources', { query, ...options });
+  }
+
+  /**
+   * Delete a data source by ID.
+   */
+  delete(dataSourceID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/data-sources/${dataSourceID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a data source by ID.
+   */
+  get(dataSourceID: string, options?: RequestOptions): APIPromise<DataSource> {
+    return this._client.get(path`/api/v1/data-sources/${dataSourceID}`, options);
+  }
+}
+
+/**
+ * Schema for a data source.
+ */
+export interface DataSource {
+  /**
+   * Unique identifier
+   */
+  id: string;
+
+  /**
+   * Component that implements the data source
+   */
+  component:
+    | { [key: string]: unknown }
+    | Shared.CloudS3DataSource
+    | Shared.CloudAzStorageBlobDataSource
+    | Shared.CloudOneDriveDataSource
+    | Shared.CloudSharepointDataSource
+    | Shared.CloudSlackDataSource
+    | Shared.CloudNotionPageDataSource
+    | Shared.CloudConfluenceDataSource
+    | Shared.CloudJiraDataSource
+    | Shared.CloudJiraDataSourceV2
+    | Shared.CloudBoxDataSource;
+
+  /**
+   * The name of the data source.
+   */
+  name: string;
+
+  project_id: string;
+
+  source_type:
+    | 'S3'
+    | 'AZURE_STORAGE_BLOB'
+    | 'GOOGLE_DRIVE'
+    | 'MICROSOFT_ONEDRIVE'
+    | 'MICROSOFT_SHAREPOINT'
+    | 'SLACK'
+    | 'NOTION_PAGE'
+    | 'CONFLUENCE'
+    | 'JIRA'
+    | 'JIRA_V2'
+    | 'BOX';
+
+  /**
+   * Creation datetime
+   */
+  created_at?: string | null;
+
+  /**
+   * Custom metadata that will be present on all data loaded from the data source
+   */
+  custom_metadata?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * Update datetime
+   */
+  updated_at?: string | null;
+
+  /**
+   * Version metadata for the data source
+   */
+  version_metadata?: DataSourceReaderVersionMetadata | null;
+}
+
+export interface DataSourceReaderVersionMetadata {
+  /**
+   * The version of the reader to use for this data source.
+   */
+  reader_version?: '1.0' | '2.0' | '2.1' | null;
+}
+
+export type DataSourceListResponse = Array<DataSource>;
+
+export interface DataSourceCreateParams {
+  /**
+   * Body param: Component that implements the data source
+   */
+  component:
+    | { [key: string]: unknown }
+    | Shared.CloudS3DataSource
+    | Shared.CloudAzStorageBlobDataSource
+    | Shared.CloudOneDriveDataSource
+    | Shared.CloudSharepointDataSource
+    | Shared.CloudSlackDataSource
+    | Shared.CloudNotionPageDataSource
+    | Shared.CloudConfluenceDataSource
+    | Shared.CloudJiraDataSource
+    | Shared.CloudJiraDataSourceV2
+    | Shared.CloudBoxDataSource;
+
+  /**
+   * Body param: The name of the data source.
+   */
+  name: string;
+
+  /**
+   * Body param
+   */
+  source_type:
+    | 'S3'
+    | 'AZURE_STORAGE_BLOB'
+    | 'GOOGLE_DRIVE'
+    | 'MICROSOFT_ONEDRIVE'
+    | 'MICROSOFT_SHAREPOINT'
+    | 'SLACK'
+    | 'NOTION_PAGE'
+    | 'CONFLUENCE'
+    | 'JIRA'
+    | 'JIRA_V2'
+    | 'BOX';
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: Custom metadata that will be present on all data loaded from the
+   * data source
+   */
+  custom_metadata?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+}
+
+export interface DataSourceUpdateParams {
+  source_type:
+    | 'S3'
+    | 'AZURE_STORAGE_BLOB'
+    | 'GOOGLE_DRIVE'
+    | 'MICROSOFT_ONEDRIVE'
+    | 'MICROSOFT_SHAREPOINT'
+    | 'SLACK'
+    | 'NOTION_PAGE'
+    | 'CONFLUENCE'
+    | 'JIRA'
+    | 'JIRA_V2'
+    | 'BOX';
+
+  /**
+   * Component that implements the data source
+   */
+  component?:
+    | { [key: string]: unknown }
+    | Shared.CloudS3DataSource
+    | Shared.CloudAzStorageBlobDataSource
+    | Shared.CloudOneDriveDataSource
+    | Shared.CloudSharepointDataSource
+    | Shared.CloudSlackDataSource
+    | Shared.CloudNotionPageDataSource
+    | Shared.CloudConfluenceDataSource
+    | Shared.CloudJiraDataSource
+    | Shared.CloudJiraDataSourceV2
+    | Shared.CloudBoxDataSource
+    | null;
+
+  /**
+   * Custom metadata that will be present on all data loaded from the data source
+   */
+  custom_metadata?: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  } | null;
+
+  /**
+   * The name of the data source.
+   */
+  name?: string | null;
+}
+
+export interface DataSourceListParams {
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+export declare namespace DataSources {
+  export {
+    type DataSource as DataSource,
+    type DataSourceReaderVersionMetadata as DataSourceReaderVersionMetadata,
+    type DataSourceListResponse as DataSourceListResponse,
+    type DataSourceCreateParams as DataSourceCreateParams,
+    type DataSourceUpdateParams as DataSourceUpdateParams,
+    type DataSourceListParams as DataSourceListParams,
+  };
+}

package/src/resources/extraction/extraction-agents/extraction-agents.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as RunsAPI from '../runs';
+import * as SchemaAPI from './schema';
+import {
+  Schema,
+  SchemaGenerateSchemaParams,
+  SchemaGenerateSchemaResponse,
+  SchemaValidateSchemaParams,
+  SchemaValidateSchemaResponse,
+} from './schema';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class ExtractionAgents extends APIResource {
+  schema: SchemaAPI.Schema = new SchemaAPI.Schema(this._client);
+
+  /**
+   * Create Extraction Agent
+   */
+  create(params: ExtractionAgentCreateParams, options?: RequestOptions): APIPromise<ExtractAgent> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/extraction/extraction-agents', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Update Extraction Agent
+   */
+  update(
+    extractionAgentID: string,
+    body: ExtractionAgentUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ExtractAgent> {
+    return this._client.put(path`/api/v1/extraction/extraction-agents/${extractionAgentID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List Extraction Agents
+   */
+  list(
+    query: ExtractionAgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ExtractionAgentListResponse> {
+    return this._client.get('/api/v1/extraction/extraction-agents', { query, ...options });
+  }
+
+  /**
+   * Delete Extraction Agent
+   */
+  delete(extractionAgentID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/api/v1/extraction/extraction-agents/${extractionAgentID}`, options);
+  }
+
+  /**
+   * Get Extraction Agent
+   */
+  get(extractionAgentID: string, options?: RequestOptions): APIPromise<ExtractAgent> {
+    return this._client.get(path`/api/v1/extraction/extraction-agents/${extractionAgentID}`, options);
+  }
+}
+
+/**
+ * Schema and configuration for an extraction agent.
+ */
+export interface ExtractAgent {
+  /**
+   * The id of the extraction agent.
+   */
+  id: string;
+
+  /**
+   * The configuration parameters for the extraction agent.
+   */
+  config: RunsAPI.ExtractConfig;
+
+  /**
+   * The schema of the data.
+   */
+  data_schema: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  };
+
+  /**
+   * The name of the extraction agent.
+   */
+  name: string;
+
+  /**
+   * The ID of the project that the extraction agent belongs to.
+   */
+  project_id: string;
+
+  /**
+   * The creation time of the extraction agent.
+   */
+  created_at?: string | null;
+
+  /**
+   * Custom configuration type for the extraction agent. Currently supports
+   * 'default'.
+   */
+  custom_configuration?: 'default' | null;
+
+  /**
+   * The last update time of the extraction agent.
+   */
+  updated_at?: string | null;
+}
+
+export type ExtractionAgentListResponse = Array<ExtractAgent>;
+
+export type ExtractionAgentDeleteResponse = unknown;
+
+export interface ExtractionAgentCreateParams {
+  /**
+   * Body param: The configuration parameters for the extraction agent.
+   */
+  config: RunsAPI.ExtractConfig;
+
+  /**
+   * Body param: The schema of the data.
+   */
+  data_schema:
+    | { [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null }
+    | string;
+
+  /**
+   * Body param: The name of the extraction schema
+   */
+  name: string;
+
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+}
+
+export interface ExtractionAgentUpdateParams {
+  /**
+   * The configuration parameters for the extraction agent.
+   */
+  config: RunsAPI.ExtractConfig;
+
+  /**
+   * The schema of the data
+   */
+  data_schema:
+    | { [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null }
+    | string;
+}
+
+export interface ExtractionAgentListParams {
+  /**
+   * Whether to include default agents in the results
+   */
+  include_default?: boolean;
+
+  organization_id?: string | null;
+
+  project_id?: string | null;
+}
+
+ExtractionAgents.Schema = Schema;
+
+export declare namespace ExtractionAgents {
+  export {
+    type ExtractAgent as ExtractAgent,
+    type ExtractionAgentListResponse as ExtractionAgentListResponse,
+    type ExtractionAgentDeleteResponse as ExtractionAgentDeleteResponse,
+    type ExtractionAgentCreateParams as ExtractionAgentCreateParams,
+    type ExtractionAgentUpdateParams as ExtractionAgentUpdateParams,
+    type ExtractionAgentListParams as ExtractionAgentListParams,
+  };
+
+  export {
+    Schema as Schema,
+    type SchemaGenerateSchemaResponse as SchemaGenerateSchemaResponse,
+    type SchemaValidateSchemaResponse as SchemaValidateSchemaResponse,
+    type SchemaGenerateSchemaParams as SchemaGenerateSchemaParams,
+    type SchemaValidateSchemaParams as SchemaValidateSchemaParams,
+  };
+}

package/src/resources/extraction/extraction-agents/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ExtractionAgents,
+  type ExtractAgent,
+  type ExtractionAgentListResponse,
+  type ExtractionAgentDeleteResponse,
+  type ExtractionAgentCreateParams,
+  type ExtractionAgentUpdateParams,
+  type ExtractionAgentListParams,
+} from './extraction-agents';
+export {
+  Schema,
+  type SchemaGenerateSchemaResponse,
+  type SchemaValidateSchemaResponse,
+  type SchemaGenerateSchemaParams,
+  type SchemaValidateSchemaParams,
+} from './schema';

package/src/resources/extraction/extraction-agents/schema.ts

@@ -0,0 +1,100 @@
+// 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 Schema extends APIResource {
+  /**
+   * Generates or refines an extraction agent's schema definition from a file,
+   * natural language prompt, or existing schema.
+   */
+  generateSchema(
+    params: SchemaGenerateSchemaParams,
+    options?: RequestOptions,
+  ): APIPromise<SchemaGenerateSchemaResponse> {
+    const { organization_id, project_id, ...body } = params;
+    return this._client.post('/api/v1/extraction/extraction-agents/schema/generate', {
+      query: { organization_id, project_id },
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Validates an extraction agent's schema definition. Returns the normalized and
+   * validated schema if valid, otherwise raises an HTTP 400.
+   */
+  validateSchema(
+    body: SchemaValidateSchemaParams,
+    options?: RequestOptions,
+  ): APIPromise<SchemaValidateSchemaResponse> {
+    return this._client.post('/api/v1/extraction/extraction-agents/schema/validation', { body, ...options });
+  }
+}
+
+/**
+ * Response schema for schema generation.
+ */
+export interface SchemaGenerateSchemaResponse {
+  /**
+   * The generated JSON schema
+   */
+  data_schema: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  };
+}
+
+/**
+ * Response schema for schema validation.
+ */
+export interface SchemaValidateSchemaResponse {
+  data_schema: {
+    [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
+  };
+}
+
+export interface SchemaGenerateSchemaParams {
+  /**
+   * Query param
+   */
+  organization_id?: string | null;
+
+  /**
+   * Query param
+   */
+  project_id?: string | null;
+
+  /**
+   * Body param: Optional schema to validate, refine, or extend during generation
+   */
+  data_schema?:
+    | { [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null }
+    | string
+    | null;
+
+  /**
+   * Body param: Optional file ID to analyze for schema generation
+   */
+  file_id?: string | null;
+
+  /**
+   * Body param: Natural language description of the data structure to extract
+   */
+  prompt?: string | null;
+}
+
+export interface SchemaValidateSchemaParams {
+  data_schema:
+    | { [key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null }
+    | string;
+}
+
+export declare namespace Schema {
+  export {
+    type SchemaGenerateSchemaResponse as SchemaGenerateSchemaResponse,
+    type SchemaValidateSchemaResponse as SchemaValidateSchemaResponse,
+    type SchemaGenerateSchemaParams as SchemaGenerateSchemaParams,
+    type SchemaValidateSchemaParams as SchemaValidateSchemaParams,
+  };
+}

package/src/resources/extraction/extraction-agents.ts

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