@mixedbread/sdk 0.1.0-alpha.10

package/src/resources/embeddings.ts

@@ -0,0 +1,248 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Embeddings extends APIResource {
+  /**
+   * Create embeddings for text or images using the specified model, encoding format,
+   * and normalization.
+   *
+   * Args: params: The parameters for creating embeddings.
+   *
+   * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+   */
+  create(
+    body: EmbeddingCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EmbeddingCreateResponse> {
+    return this._client.post('/v1/embeddings', { body, ...options });
+  }
+}
+
+export interface Embedding {
+  /**
+   * The encoded embedding.
+   */
+  embedding: Array<number> | Array<number> | string;
+
+  /**
+   * The index of the embedding.
+   */
+  index: number;
+
+  /**
+   * The object type of the embedding.
+   */
+  object: 'embedding';
+}
+
+export interface EmbeddingCreateResponse {
+  /**
+   * The usage of the model
+   */
+  usage: EmbeddingCreateResponse.Usage;
+
+  /**
+   * The model used
+   */
+  model: string;
+
+  /**
+   * The created embeddings.
+   */
+  data: Array<Embedding> | Array<EmbeddingCreateResponse.UnionMember1>;
+
+  /**
+   * The object type of the response
+   */
+  object?:
+    | 'list'
+    | 'parsing_job'
+    | 'job'
+    | 'embedding'
+    | 'embedding_dict'
+    | 'text_document'
+    | 'file'
+    | 'vector_store'
+    | 'vector_store.file'
+    | 'api_key';
+
+  /**
+   * Whether the embeddings are normalized.
+   */
+  normalized: boolean;
+
+  /**
+   * The encoding format of the embeddings.
+   */
+  encoding_format:
+    | 'float'
+    | 'float16'
+    | 'base64'
+    | 'binary'
+    | 'ubinary'
+    | 'int8'
+    | 'uint8'
+    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+
+  /**
+   * The number of dimensions used for the embeddings.
+   */
+  dimensions: number | null;
+}
+
+export namespace EmbeddingCreateResponse {
+  /**
+   * The usage of the model
+   */
+  export interface Usage {
+    /**
+     * The number of tokens used for the prompt
+     */
+    prompt_tokens: number;
+
+    /**
+     * The total number of tokens used
+     */
+    total_tokens: number;
+
+    /**
+     * The number of tokens used for the completion
+     */
+    completion_tokens?: number | null;
+  }
+
+  export interface UnionMember1 {
+    /**
+     * The encoded embedding data by encoding format.Returned, if more than one
+     * encoding format is used.
+     */
+    embedding: UnionMember1.Embedding;
+
+    /**
+     * The index of the embedding.
+     */
+    index: number;
+
+    /**
+     * The object type of the embedding.
+     */
+    object: 'embedding_dict';
+  }
+
+  export namespace UnionMember1 {
+    /**
+     * The encoded embedding data by encoding format.Returned, if more than one
+     * encoding format is used.
+     */
+    export interface Embedding {
+      float?: Array<number>;
+
+      int8?: Array<number>;
+
+      uint8?: Array<number>;
+
+      binary?: Array<number>;
+
+      ubinary?: Array<number>;
+
+      base64?: Array<string>;
+    }
+  }
+}
+
+export interface EmbeddingCreateParams {
+  /**
+   * The model to use for creating embeddings.
+   */
+  model: string;
+
+  /**
+   * The input to create embeddings for.
+   */
+  input: string | EmbeddingCreateParams.ImageURLInput | EmbeddingCreateParams.TextInput;
+
+  /**
+   * The number of dimensions to use for the embeddings.
+   */
+  dimensions?: number | null;
+
+  /**
+   * The prompt to use for the embedding creation.
+   */
+  prompt?: string | null;
+
+  /**
+   * Whether to normalize the embeddings.
+   */
+  normalized?: boolean;
+
+  /**
+   * The encoding format of the embeddings.
+   */
+  encoding_format?:
+    | 'float'
+    | 'float16'
+    | 'base64'
+    | 'binary'
+    | 'ubinary'
+    | 'int8'
+    | 'uint8'
+    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+}
+
+export namespace EmbeddingCreateParams {
+  /**
+   * Model for image input validation.
+   */
+  export interface ImageURLInput {
+    /**
+     * Input type identifier
+     */
+    type?: 'image_url';
+
+    /**
+     * The image input specification.
+     */
+    image: ImageURLInput.Image;
+  }
+
+  export namespace ImageURLInput {
+    /**
+     * The image input specification.
+     */
+    export interface Image {
+      /**
+       * The image URL. Can be either a URL or a Data URI.
+       */
+      url: string;
+    }
+  }
+
+  /**
+   * Model for text input validation.
+   *
+   * Attributes: type: Input type identifier, always "text" text: The actual text
+   * content, with length and whitespace constraints
+   */
+  export interface TextInput {
+    /**
+     * Input type identifier
+     */
+    type?: 'text';
+
+    /**
+     * Text content to process
+     */
+    text: string;
+  }
+}
+
+export declare namespace Embeddings {
+  export {
+    type Embedding as Embedding,
+    type EmbeddingCreateResponse as EmbeddingCreateResponse,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
+  };
+}

package/src/resources/extractions/content.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Content extends APIResource {
+  /**
+   * Extract content from a string using the provided schema.
+   *
+   * Args: params: The parameters for extracting content from a string.
+   *
+   * Returns: The extracted content.
+   */
+  create(body: ContentCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExtractionResult> {
+    return this._client.post('/v1/extractions/content', { body, ...options });
+  }
+}
+
+/**
+ * The result of an extraction job.
+ */
+export interface ExtractionResult {
+  data: unknown;
+
+  warnings: Array<string>;
+}
+
+export interface ContentCreateParams {
+  /**
+   * The content to extract from
+   */
+  content: string;
+
+  /**
+   * The JSON schema to use for extraction
+   */
+  json_schema: unknown;
+}
+
+export declare namespace Content {
+  export { type ExtractionResult as ExtractionResult, type ContentCreateParams as ContentCreateParams };
+}

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,105 @@
+// 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 {
+  /**
+   * Unique identifier for the extraction job
+   */
+  id: string;
+
+  /**
+   * ID of the organization that owns this job
+   */
+  organization_id: string;
+
+  /**
+   * ID of the file being extracted
+   */
+  file_id: string;
+
+  /**
+   * When the job was created
+   */
+  created_at: string;
+
+  /**
+   * When the job was last updated
+   */
+  updated_at: string;
+
+  /**
+   * When the job started processing
+   */
+  started_at: string | null;
+
+  /**
+   * When the job finished processing
+   */
+  finished_at: string | null;
+
+  /**
+   * Current status of the job
+   */
+  status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+
+  /**
+   * The result of an extraction job.
+   */
+  result: ContentAPI.ExtractionResult | null;
+
+  /**
+   * Error information if failed
+   */
+  error: unknown | null;
+
+  /**
+   * The JSON schema used for extraction
+   */
+  json_schema: unknown;
+}
+
+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,
+  };
+}