ogx-client 0.7.2-rc1

package/src/resources/conversations.ts

@@ -0,0 +1,9 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './conversations/index';

package/src/resources/embeddings.ts

@@ -0,0 +1,130 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+/**
+ * OGX Inference API for generating completions, chat completions, and embeddings.
+ *
+ * This API provides the raw interface to the underlying models. Three kinds of models are supported:
+ * - LLM models: these models generate "raw" and "chat" (conversational) completions.
+ * - Embedding models: these models generate embeddings to be used for semantic search.
+ * - Rerank models: these models reorder the documents based on their relevance to a query.
+ */
+export class Embeddings extends APIResource {
+  /**
+   * Generate OpenAI-compatible embeddings for the given input using the specified
+   * model.
+   */
+  create(
+    body: EmbeddingCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CreateEmbeddingsResponse> {
+    return this._client.post('/v1/embeddings', { body, ...options });
+  }
+}
+
+/**
+ * Response from an OpenAI-compatible embeddings request.
+ */
+export interface CreateEmbeddingsResponse {
+  /**
+   * List of embedding data objects.
+   */
+  data: Array<CreateEmbeddingsResponse.Data>;
+
+  /**
+   * The model that was used to generate the embeddings.
+   */
+  model: string;
+
+  /**
+   * Usage information.
+   */
+  usage: CreateEmbeddingsResponse.Usage;
+
+  /**
+   * The object type.
+   */
+  object?: 'list';
+}
+
+export namespace CreateEmbeddingsResponse {
+  /**
+   * A single embedding data object from an OpenAI-compatible embeddings response.
+   */
+  export interface Data {
+    /**
+     * The embedding vector as a list of floats (when encoding_format='float') or as a
+     * base64-encoded string.
+     */
+    embedding: Array<number> | string;
+
+    /**
+     * The index of the embedding in the input list.
+     */
+    index: number;
+
+    /**
+     * The object type.
+     */
+    object?: 'embedding';
+  }
+
+  /**
+   * Usage information.
+   */
+  export interface Usage {
+    /**
+     * The number of tokens in the input.
+     */
+    prompt_tokens: number;
+
+    /**
+     * The total number of tokens used.
+     */
+    total_tokens: number;
+  }
+}
+
+export interface EmbeddingCreateParams {
+  /**
+   * Input text to embed, encoded as a string or array of tokens.
+   */
+  input: string | Array<string> | Array<number> | Array<Array<number>>;
+
+  /**
+   * The identifier of the model to use.
+   */
+  model: string;
+
+  /**
+   * The number of dimensions for output embeddings.
+   */
+  dimensions?: number;
+
+  /**
+   * The format to return the embeddings in.
+   */
+  encoding_format?: 'float' | 'base64';
+
+  /**
+   * A unique identifier representing your end-user.
+   */
+  user?: string;
+
+  [k: string]: unknown;
+}
+
+export declare namespace Embeddings {
+  export {
+    type CreateEmbeddingsResponse as CreateEmbeddingsResponse,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
+  };
+}

package/src/resources/files.ts

@@ -0,0 +1,225 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// 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 { OpenAICursorPage, type OpenAICursorPageParams } from '../pagination';
+
+/**
+ * This API is used to upload documents that can be used with other OGX APIs.
+ */
+export class Files extends APIResource {
+  /**
+   * Upload a file.
+   */
+  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+  }
+
+  /**
+   * Get file
+   */
+  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this._client.get(`/v1/files/${fileId}`, options);
+  }
+
+  /**
+   * List files
+   */
+  list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesOpenAICursorPage, File>;
+  list(options?: Core.RequestOptions): Core.PagePromise<FilesOpenAICursorPage, File>;
+  list(
+    query: FileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FilesOpenAICursorPage, File> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/v1/files', FilesOpenAICursorPage, { query, ...options });
+  }
+
+  /**
+   * Delete file
+   */
+  delete(fileId: string, options?: Core.RequestOptions): Core.APIPromise<DeleteFileResponse> {
+    return this._client.delete(`/v1/files/${fileId}`, options);
+  }
+
+  /**
+   * Retrieve file content
+   */
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string> {
+    return this._client.get(`/v1/files/${fileId}/content`, options);
+  }
+}
+
+export class FilesOpenAICursorPage extends OpenAICursorPage<File> {}
+
+/**
+ * Response for deleting a file in OpenAI Files API.
+ */
+export interface DeleteFileResponse {
+  /**
+   * The file identifier that was deleted.
+   */
+  id: string;
+
+  /**
+   * Whether the file was successfully deleted.
+   */
+  deleted: boolean;
+
+  /**
+   * The object type, which is always 'file'.
+   */
+  object?: 'file';
+}
+
+/**
+ * OpenAI File object as defined in the OpenAI Files API.
+ */
+export interface File {
+  /**
+   * The file identifier, which can be referenced in the API endpoints.
+   */
+  id: string;
+
+  /**
+   * The size of the file, in bytes.
+   */
+  bytes: number;
+
+  /**
+   * The Unix timestamp (in seconds) for when the file was created.
+   */
+  created_at: number;
+
+  /**
+   * The name of the file.
+   */
+  filename: string;
+
+  /**
+   * The intended purpose of the file.
+   */
+  purpose: 'assistants' | 'batch';
+
+  /**
+   * @deprecated Deprecated. The current status of the file.
+   */
+  status: 'uploaded' | 'processed' | 'error';
+
+  /**
+   * @deprecated Deprecated. For details on why a fine-tuning training file failed
+   * validation, see the error field on fine_tuning.job.
+   */
+  status_details: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the file expires.
+   */
+  expires_at?: number | null;
+
+  /**
+   * The object type, which is always 'file'.
+   */
+  object?: 'file';
+}
+
+/**
+ * Response for listing files in OpenAI Files API.
+ */
+export interface ListFilesResponse {
+  /**
+   * The list of files.
+   */
+  data: Array<File>;
+
+  /**
+   * The ID of the first file in the list for pagination.
+   */
+  first_id: string;
+
+  /**
+   * Whether there are more files available beyond this page.
+   */
+  has_more: boolean;
+
+  /**
+   * The ID of the last file in the list for pagination.
+   */
+  last_id: string;
+
+  /**
+   * The object type, which is always 'list'.
+   */
+  object?: 'list';
+}
+
+export type FileContentResponse = string;
+
+export interface FileCreateParams {
+  /**
+   * The file to upload.
+   */
+  file: Core.Uploadable;
+
+  /**
+   * The intended purpose of the uploaded file.
+   */
+  purpose: 'assistants' | 'batch';
+
+  /**
+   * Control expiration of uploaded files.
+   */
+  expires_after?: FileCreateParams.ExpiresAfter | null;
+}
+
+export namespace FileCreateParams {
+  /**
+   * Control expiration of uploaded files.
+   */
+  export interface ExpiresAfter {
+    /**
+     * The anchor point for expiration, must be 'created_at'.
+     */
+    anchor: 'created_at';
+
+    /**
+     * Seconds until expiration, between 3600 (1 hour) and 2592000 (30 days).
+     */
+    seconds: number;
+  }
+}
+
+export interface FileListParams extends OpenAICursorPageParams {
+  /**
+   * Sort order by created_at timestamp ('asc' or 'desc').
+   */
+  order?: 'asc' | 'desc' | null;
+
+  /**
+   * Filter files by purpose.
+   */
+  purpose?: 'assistants' | 'batch' | null;
+}
+
+Files.FilesOpenAICursorPage = FilesOpenAICursorPage;
+
+export declare namespace Files {
+  export {
+    type DeleteFileResponse as DeleteFileResponse,
+    type File as File,
+    type ListFilesResponse as ListFilesResponse,
+    type FileContentResponse as FileContentResponse,
+    FilesOpenAICursorPage as FilesOpenAICursorPage,
+    type FileCreateParams as FileCreateParams,
+    type FileListParams as FileListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,104 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export { Alpha } from './alpha/alpha';
+export {
+  BatchListResponsesOpenAICursorPage,
+  Batches,
+  type BatchCreateResponse,
+  type BatchRetrieveResponse,
+  type BatchListResponse,
+  type BatchCancelResponse,
+  type BatchCreateParams,
+  type BatchListParams,
+} from './batches';
+export { Chat, type ChatCompletionChunk } from './chat/chat';
+export {
+  Completions,
+  type CompletionCreateResponse,
+  type CompletionCreateParams,
+  type CompletionCreateParamsNonStreaming,
+  type CompletionCreateParamsStreaming,
+} from './completions';
+export {
+  Conversations,
+  type ConversationObject,
+  type ConversationDeleteResponse,
+  type ConversationCreateParams,
+  type ConversationUpdateParams,
+} from './conversations/conversations';
+export { Embeddings, type CreateEmbeddingsResponse, type EmbeddingCreateParams } from './embeddings';
+export {
+  FilesOpenAICursorPage,
+  Files,
+  type DeleteFileResponse,
+  type File,
+  type ListFilesResponse,
+  type FileContentResponse,
+  type FileCreateParams,
+  type FileListParams,
+} from './files';
+export { Inspect } from './inspect';
+export { Models, type ListModelsResponse, type Model, type ModelRetrieveResponse } from './models/models';
+export { Moderations, type CreateResponse, type ModerationCreateParams } from './moderations';
+export {
+  Prompts,
+  type ListPromptsResponse,
+  type Prompt,
+  type PromptListResponse,
+  type PromptCreateParams,
+  type PromptRetrieveParams,
+  type PromptUpdateParams,
+  type PromptSetDefaultVersionParams,
+} from './prompts/prompts';
+export { Providers, type ProviderListResponse } from './providers';
+export {
+  ResponseListResponsesOpenAICursorPage,
+  Responses,
+  type CompactedResponse,
+  type ResponseInput,
+  type ResponseMessage,
+  type ResponseObject,
+  type ResponseObjectStream,
+  type ResponseOutput,
+  type ResponseListResponse,
+  type ResponseDeleteResponse,
+  type ResponseCreateParams,
+  type ResponseCreateParamsNonStreaming,
+  type ResponseCreateParamsStreaming,
+  type ResponseListParams,
+  type ResponseCompactParams,
+} from './responses/responses';
+export { Routes, type RouteListResponse, type RouteListParams } from './routes';
+export { Safety, type RunShieldResponse, type SafetyRunShieldParams } from './safety';
+export {
+  Shields,
+  type ListShieldsResponse,
+  type Shield,
+  type ShieldListResponse,
+  type ShieldRegisterParams,
+} from './shields';
+export {
+  VectorIo,
+  type QueryChunksResponse,
+  type VectorIoInsertParams,
+  type VectorIoQueryParams,
+} from './vector-io';
+export {
+  VectorStoresOpenAICursorPage,
+  VectorStores,
+  type ListVectorStoresResponse,
+  type VectorStore,
+  type VectorStoreDeleteResponse,
+  type VectorStoreSearchResponse,
+  type VectorStoreCreateParams,
+  type VectorStoreUpdateParams,
+  type VectorStoreListParams,
+  type VectorStoreSearchParams,
+} from './vector-stores/vector-stores';

package/src/resources/inspect.ts

@@ -0,0 +1,30 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as Shared from './shared';
+
+/**
+ * APIs for inspecting the OGX service, including health status, available API routes with methods and implementing providers.
+ */
+export class Inspect extends APIResource {
+  /**
+   * Get the current health status of the service.
+   */
+  health(options?: Core.RequestOptions): Core.APIPromise<Shared.HealthInfo> {
+    return this._client.get('/v1/health', options);
+  }
+
+  /**
+   * Get the version of the service.
+   */
+  version(options?: Core.RequestOptions): Core.APIPromise<Shared.VersionInfo> {
+    return this._client.get('/v1/version', options);
+  }
+}

package/src/resources/models/index.ts

@@ -0,0 +1,10 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Models, type ListModelsResponse, type Model, type ModelRetrieveResponse } from './models';
+export { OpenAI } from './openai';

package/src/resources/models/models.ts

@@ -0,0 +1,133 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as OpenAIAPI from './openai';
+import { OpenAI } from './openai';
+
+export class Models extends APIResource {
+  openai: OpenAIAPI.OpenAI = new OpenAIAPI.OpenAI(this._client);
+
+  /**
+   * Get a model by its identifier.
+   */
+  retrieve(modelId: string, options?: Core.RequestOptions): Core.APIPromise<ModelRetrieveResponse> {
+    return this._client.get(`/v1/models/${modelId}`, options);
+  }
+
+  /**
+   * List models using the OpenAI API.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<ListModelsResponse> {
+    return this._client.get('/v1/models', options);
+  }
+}
+
+/**
+ * Response containing a list of OpenAI model objects.
+ */
+export interface ListModelsResponse {
+  /**
+   * List of OpenAI model objects.
+   */
+  data: Array<Model>;
+
+  object?: 'list';
+}
+
+/**
+ * A model from OpenAI.
+ *
+ * :id: The ID of the model :object: The object type, which will be "model"
+ * :created: The Unix timestamp in seconds when the model was created :owned_by:
+ * The owner of the model :custom_metadata: OGX-specific metadata including
+ * model_type, provider info, and additional metadata
+ */
+export interface Model {
+  id: string;
+
+  created: number;
+
+  owned_by: string;
+
+  custom_metadata?: { [key: string]: unknown } | null;
+
+  object?: 'model';
+}
+
+/**
+ * A model resource representing an AI model registered in OGX.
+ */
+export interface ModelRetrieveResponse {
+  /**
+   * The model identifier (OpenAI-compatible alias for identifier).
+   */
+  id: string;
+
+  /**
+   * Unique identifier for this resource in ogx
+   */
+  identifier: string;
+
+  /**
+   * The object type, always 'model'.
+   */
+  object: 'model';
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * The Unix timestamp in seconds when the model was created.
+   */
+  created?: number;
+
+  /**
+   * Any additional metadata for this model
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Enumeration of supported model types in OGX.
+   */
+  model_type?: 'llm' | 'embedding' | 'rerank';
+
+  /**
+   * Enable model availability check during registration. When false (default),
+   * validation is deferred to runtime and model is preserved during provider
+   * refresh.
+   */
+  model_validation?: boolean | null;
+
+  /**
+   * The owner of the model.
+   */
+  owned_by?: string;
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'model';
+}
+
+Models.OpenAI = OpenAI;
+
+export declare namespace Models {
+  export {
+    type ListModelsResponse as ListModelsResponse,
+    type Model as Model,
+    type ModelRetrieveResponse as ModelRetrieveResponse,
+  };
+
+  export { OpenAI as OpenAI };
+}

package/src/resources/models/openai.ts

@@ -0,0 +1,20 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as ModelsAPI from './models';
+
+export class OpenAI extends APIResource {
+  /**
+   * List models using the OpenAI API.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<ModelsAPI.ListModelsResponse> {
+    return this._client.get('/v1/models', options);
+  }
+}

package/src/resources/models.ts

@@ -0,0 +1,9 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './models/index';