@mixedbread/sdk 0.1.0-alpha.8

package/src/resources/extractions/extractions.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as ContentAPI from './content';
+import { Content, ContentCreateParams, ExtractionResult } from './content';
+import * as JobsAPI from './jobs';
+import { ExtractionJob, JobCreateParams, Jobs } from './jobs';
+import * as SchemaAPI from './schema';
+import {
+  CreatedJsonSchema,
+  EnhancedJsonSchema,
+  Schema,
+  SchemaCreateParams,
+  SchemaEnhanceParams,
+  SchemaValidateParams,
+  ValidatedJsonSchema,
+} from './schema';
+
+export class Extractions extends APIResource {
+  jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
+  schema: SchemaAPI.Schema = new SchemaAPI.Schema(this._client);
+  content: ContentAPI.Content = new ContentAPI.Content(this._client);
+}
+
+Extractions.Jobs = Jobs;
+Extractions.Schema = Schema;
+Extractions.Content = Content;
+
+export declare namespace Extractions {
+  export { Jobs as Jobs, type ExtractionJob as ExtractionJob, type JobCreateParams as JobCreateParams };
+
+  export {
+    Schema as Schema,
+    type CreatedJsonSchema as CreatedJsonSchema,
+    type EnhancedJsonSchema as EnhancedJsonSchema,
+    type ValidatedJsonSchema as ValidatedJsonSchema,
+    type SchemaCreateParams as SchemaCreateParams,
+    type SchemaEnhanceParams as SchemaEnhanceParams,
+    type SchemaValidateParams as SchemaValidateParams,
+  };
+
+  export {
+    Content as Content,
+    type ExtractionResult as ExtractionResult,
+    type ContentCreateParams as ContentCreateParams,
+  };
+}

package/src/resources/extractions/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Content, type ExtractionResult, type ContentCreateParams } from './content';
+export { Extractions } from './extractions';
+export { Jobs, type ExtractionJob, type JobCreateParams } from './jobs';
+export {
+  Schema,
+  type CreatedJsonSchema,
+  type EnhancedJsonSchema,
+  type ValidatedJsonSchema,
+  type SchemaCreateParams,
+  type SchemaEnhanceParams,
+  type SchemaValidateParams,
+} from './schema';

package/src/resources/extractions/jobs.ts

@@ -0,0 +1,55 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as ContentAPI from './content';
+
+export class Jobs extends APIResource {
+  /**
+   * Start an extraction job for the provided file and schema.
+   *
+   * Args: params: The parameters for creating an extraction job.
+   *
+   * Returns: The created extraction job.
+   */
+  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExtractionJob> {
+    return this._client.post('/v1/extractions/jobs', { body, ...options });
+  }
+
+  /**
+   * Get detailed information about a specific extraction job.
+   *
+   * Args: job_id: The ID of the extraction job.
+   *
+   * Returns: Detailed information about the extraction job.
+   */
+  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ExtractionJob> {
+    return this._client.get(`/v1/extractions/jobs/${jobId}`, options);
+  }
+}
+
+/**
+ * A job for extracting structured data from documents.
+ */
+export interface ExtractionJob {
+  /**
+   * Result of an extraction operation.
+   */
+  result: ContentAPI.ExtractionResult | null;
+}
+
+export interface JobCreateParams {
+  /**
+   * The ID of the file to extract from
+   */
+  file_id: string;
+
+  /**
+   * The JSON schema to use for extraction
+   */
+  json_schema: unknown;
+}
+
+export declare namespace Jobs {
+  export { type ExtractionJob as ExtractionJob, type JobCreateParams as JobCreateParams };
+}

package/src/resources/extractions/schema.ts

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Schema extends APIResource {
+  /**
+   * Create a schema with the provided parameters.
+   *
+   * Args: params: The parameters for creating a schema.
+   *
+   * Returns: The created schema.
+   */
+  create(body: SchemaCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreatedJsonSchema> {
+    return this._client.post('/v1/extractions/schema', { body, ...options });
+  }
+
+  /**
+   * Enhance a schema by enriching the descriptions to aid extraction.
+   *
+   * Args: params: The parameters for enhancing a schema.
+   *
+   * Returns: The enhanced schema.
+   */
+  enhance(body: SchemaEnhanceParams, options?: Core.RequestOptions): Core.APIPromise<EnhancedJsonSchema> {
+    return this._client.post('/v1/extractions/schema/enhance', { body, ...options });
+  }
+
+  /**
+   * Validate a schema.
+   *
+   * Args: params: The parameters for validating a schema.
+   *
+   * Returns: The validation result.
+   */
+  validate(body: SchemaValidateParams, options?: Core.RequestOptions): Core.APIPromise<ValidatedJsonSchema> {
+    return this._client.post('/v1/extractions/schema/validate', { body, ...options });
+  }
+}
+
+/**
+ * Result of creating a JSON schema.
+ */
+export interface CreatedJsonSchema {
+  /**
+   * The created JSON schema
+   */
+  json_schema: unknown;
+}
+
+/**
+ * Result of enhancing a JSON schema.
+ */
+export interface EnhancedJsonSchema {
+  /**
+   * The enhanced JSON schema
+   */
+  json_schema: unknown;
+}
+
+/**
+ * Result of validating a JSON schema.
+ */
+export interface ValidatedJsonSchema {
+  /**
+   * Whether the schema is valid
+   */
+  is_valid: boolean;
+
+  /**
+   * List of validation errors
+   */
+  errors: Array<string>;
+
+  /**
+   * The validated JSON schema
+   */
+  json_schema: unknown;
+}
+
+export interface SchemaCreateParams {
+  /**
+   * Description of the data to extract
+   */
+  description: string;
+}
+
+export interface SchemaEnhanceParams {
+  /**
+   * The JSON schema to enhance
+   */
+  json_schema: unknown;
+}
+
+export interface SchemaValidateParams {
+  /**
+   * The JSON schema to validate
+   */
+  json_schema: unknown;
+}
+
+export declare namespace Schema {
+  export {
+    type CreatedJsonSchema as CreatedJsonSchema,
+    type EnhancedJsonSchema as EnhancedJsonSchema,
+    type ValidatedJsonSchema as ValidatedJsonSchema,
+    type SchemaCreateParams as SchemaCreateParams,
+    type SchemaEnhanceParams as SchemaEnhanceParams,
+    type SchemaValidateParams as SchemaValidateParams,
+  };
+}

package/src/resources/files.ts

@@ -0,0 +1,181 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import { isRequestOptions } from '../core';
+import * as Core from '../core';
+import { LimitOffset, type LimitOffsetParams } from '../pagination';
+import { type Response } from '../_shims/index';
+
+export class Files extends APIResource {
+  /**
+   * Upload a new file.
+   *
+   * Args: file: The file to upload.
+   *
+   * Returns: FileResponse: The response containing the details of the uploaded file.
+   */
+  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
+    return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+  }
+
+  /**
+   * Retrieve details of a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to retrieve.
+   *
+   * Returns: FileResponse: The response containing the file details.
+   */
+  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
+    return this._client.get(`/v1/files/${fileId}`, options);
+  }
+
+  /**
+   * Update the details of a specific file.
+   *
+   * Args: file_id: The ID of the file to update. file: The new details for the file.
+   *
+   * Returns: FileObject: The updated file details.
+   */
+  update(fileId: string, body: FileUpdateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
+    return this._client.post(`/v1/files/${fileId}`, Core.multipartFormRequestOptions({ body, ...options }));
+  }
+
+  /**
+   * List all files for the authenticated user.
+   *
+   * Args: pagination: The pagination options
+   *
+   * Returns: A list of files belonging to the user.
+   */
+  list(
+    query?: FileListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FileObjectsLimitOffset, FileObject>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FileObjectsLimitOffset, FileObject>;
+  list(
+    query: FileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FileObjectsLimitOffset, FileObject> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/v1/files', FileObjectsLimitOffset, { query, ...options });
+  }
+
+  /**
+   * Delete a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to delete.
+   *
+   * Returns: FileDeleted: The response containing the details of the deleted file.
+   */
+  delete(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileDeleteResponse> {
+    return this._client.delete(`/v1/files/${fileId}`, options);
+  }
+
+  /**
+   * Download a specific file by its ID.
+   *
+   * Args: file_id: The ID of the file to download.
+   *
+   * Returns: FileStreamResponse: The response containing the file to be downloaded.
+   */
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Response> {
+    return this._client.get(`/v1/files/${fileId}/content`, {
+      ...options,
+      headers: { Accept: 'application/octet-stream', ...options?.headers },
+      __binaryResponse: true,
+    });
+  }
+}
+
+export class FileObjectsLimitOffset extends LimitOffset<FileObject> {}
+
+/**
+ * A model representing a file object in the system.
+ *
+ * This model contains metadata about files stored in the system, including
+ * identifiers, size information, and timestamps.
+ */
+export interface FileObject {
+  /**
+   * Unique identifier for the file
+   */
+  id: string;
+
+  /**
+   * Name of the file including extension
+   */
+  filename: string;
+
+  /**
+   * Size of the file in bytes
+   */
+  bytes: number;
+
+  /**
+   * MIME type of the file
+   */
+  mime_type: string;
+
+  /**
+   * Version of the file
+   */
+  version: number;
+
+  /**
+   * Timestamp when the file was created
+   */
+  created_at: string;
+
+  /**
+   * Timestamp when the file was last updated
+   */
+  updated_at: string;
+}
+
+export interface FileDeleteResponse {
+  /**
+   * The ID of the deleted file
+   */
+  id: string;
+
+  /**
+   * Whether the file was deleted
+   */
+  deleted?: boolean;
+
+  /**
+   * The type of the deleted object
+   */
+  object?: 'file';
+}
+
+export interface FileCreateParams {
+  /**
+   * The file to upload
+   */
+  file: Core.Uploadable;
+}
+
+export interface FileUpdateParams {
+  /**
+   * The file to update
+   */
+  file: Core.Uploadable;
+}
+
+export interface FileListParams extends LimitOffsetParams {}
+
+Files.FileObjectsLimitOffset = FileObjectsLimitOffset;
+
+export declare namespace Files {
+  export {
+    type FileObject as FileObject,
+    type FileDeleteResponse as FileDeleteResponse,
+    FileObjectsLimitOffset as FileObjectsLimitOffset,
+    type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileListParams as FileListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export { Extractions } from './extractions/extractions';
+export {
+  FileObjectsLimitOffset,
+  Files,
+  type FileObject,
+  type FileDeleteResponse,
+  type FileCreateParams,
+  type FileUpdateParams,
+  type FileListParams,
+} from './files';
+export { Parsing } from './parsing/parsing';
+export {
+  VectorStoresLimitOffset,
+  VectorStores,
+  type ExpiresAfter,
+  type FileCounts,
+  type ScoredVectorStoreChunk,
+  type VectorStore,
+  type VectorStoreSearchOptions,
+  type VectorStoreDeleteResponse,
+  type VectorStoreQuestionAnsweringResponse,
+  type VectorStoreSearchResponse,
+  type VectorStoreCreateParams,
+  type VectorStoreUpdateParams,
+  type VectorStoreListParams,
+  type VectorStoreQuestionAnsweringParams,
+  type VectorStoreSearchParams,
+} from './vector-stores/vector-stores';
+export { type InfoResponse } from './top-level';

package/src/resources/parsing/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  JobListResponsesLimitOffset,
+  Jobs,
+  type ParsingJob,
+  type JobListResponse,
+  type JobDeleteResponse,
+  type JobCreateParams,
+  type JobListParams,
+} from './jobs';
+export { Parsing } from './parsing';