ogx-client 0.7.2-rc1 → 0.7.2

package/dist/src/resources/moderations.ts

@@ -0,0 +1,97 @@
+// 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';
+
+/**
+ * OpenAI-compatible Moderations API.
+ */
+export class Moderations extends APIResource {
+  /**
+   * Classifies if text inputs are potentially harmful. OpenAI-compatible endpoint.
+   */
+  create(body: ModerationCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateResponse> {
+    return this._client.post('/v1/moderations', { body, ...options });
+  }
+}
+
+/**
+ * A moderation object containing the results of content classification.
+ */
+export interface CreateResponse {
+  /**
+   * The unique identifier for the moderation request
+   */
+  id: string;
+
+  /**
+   * The model used to generate the moderation results
+   */
+  model: string;
+
+  /**
+   * A list of moderation result objects
+   */
+  results: Array<CreateResponse.Result>;
+}
+
+export namespace CreateResponse {
+  /**
+   * A moderation result object containing flagged status and category information.
+   */
+  export interface Result {
+    /**
+     * Whether any of the below categories are flagged
+     */
+    flagged: boolean;
+
+    /**
+     * A dictionary of the categories, and whether they are flagged or not
+     */
+    categories?: { [key: string]: boolean } | null;
+
+    /**
+     * A dictionary of the categories along with the input type(s) that the score
+     * applies to
+     */
+    category_applied_input_types?: { [key: string]: Array<string> } | null;
+
+    /**
+     * A dictionary of the categories along with their scores as predicted by model
+     */
+    category_scores?: { [key: string]: number } | null;
+
+    /**
+     * Additional metadata about the moderation
+     */
+    metadata?: { [key: string]: unknown };
+
+    /**
+     * A message to convey to the user about the moderation result
+     */
+    user_message?: string | null;
+  }
+}
+
+export interface ModerationCreateParams {
+  /**
+   * Input (or inputs) to classify. Can be a single string or an array of strings.
+   */
+  input: string | Array<string>;
+
+  /**
+   * The content moderation model to use. If not specified, the default shield will
+   * be used.
+   */
+  model?: string | null;
+}
+
+export declare namespace Moderations {
+  export { type CreateResponse as CreateResponse, type ModerationCreateParams as ModerationCreateParams };
+}

package/dist/src/resources/prompts/index.ts

@@ -0,0 +1,19 @@
+// 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 {
+  Prompts,
+  type ListPromptsResponse,
+  type Prompt,
+  type PromptListResponse,
+  type PromptCreateParams,
+  type PromptRetrieveParams,
+  type PromptUpdateParams,
+  type PromptSetDefaultVersionParams,
+} from './prompts';
+export { Versions } from './versions';

package/dist/src/resources/prompts/prompts.ts

@@ -0,0 +1,188 @@
+// 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 * as VersionsAPI from './versions';
+import { Versions } from './versions';
+
+/**
+ * Protocol for prompt management operations.
+ */
+export class Prompts extends APIResource {
+  versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
+
+  /**
+   * Create a new prompt.
+   */
+  create(body: PromptCreateParams, options?: Core.RequestOptions): Core.APIPromise<Prompt> {
+    return this._client.post('/v1/prompts', { body, ...options });
+  }
+
+  /**
+   * Get a prompt by its identifier and optional version.
+   */
+  retrieve(
+    promptId: string,
+    query?: PromptRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt>;
+  retrieve(promptId: string, options?: Core.RequestOptions): Core.APIPromise<Prompt>;
+  retrieve(
+    promptId: string,
+    query: PromptRetrieveParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt> {
+    if (isRequestOptions(query)) {
+      return this.retrieve(promptId, {}, query);
+    }
+    return this._client.get(`/v1/prompts/${promptId}`, { query, ...options });
+  }
+
+  /**
+   * Update an existing prompt (increments version).
+   */
+  update(promptId: string, body: PromptUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Prompt> {
+    return this._client.put(`/v1/prompts/${promptId}`, { body, ...options });
+  }
+
+  /**
+   * List all prompts.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<PromptListResponse> {
+    return (
+      this._client.get('/v1/prompts', options) as Core.APIPromise<{ data: PromptListResponse }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Delete a prompt.
+   */
+  delete(promptId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/prompts/${promptId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Set which version of a prompt should be the default in get_prompt (latest).
+   */
+  setDefaultVersion(
+    promptId: string,
+    body: PromptSetDefaultVersionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt> {
+    return this._client.put(`/v1/prompts/${promptId}/set-default-version`, { body, ...options });
+  }
+}
+
+/**
+ * Response model to list prompts.
+ */
+export interface ListPromptsResponse {
+  data: PromptListResponse;
+}
+
+/**
+ * A prompt resource representing a stored OpenAI Compatible prompt template in
+ * OGX.
+ */
+export interface Prompt {
+  /**
+   * Unique identifier in format 'pmpt\_<48-digit-hash>'
+   */
+  prompt_id: string;
+
+  /**
+   * Version (integer starting at 1, incremented on save)
+   */
+  version: number;
+
+  /**
+   * Boolean indicating whether this version is the default version
+   */
+  is_default?: boolean;
+
+  /**
+   * The system prompt with variable placeholders
+   */
+  prompt?: string | null;
+
+  /**
+   * List of variable names that can be used in the prompt template
+   */
+  variables?: Array<string>;
+}
+
+export type PromptListResponse = Array<Prompt>;
+
+export interface PromptCreateParams {
+  /**
+   * The prompt text content with variable placeholders.
+   */
+  prompt: string;
+
+  /**
+   * List of variable names that can be used in the prompt template.
+   */
+  variables?: Array<string> | null;
+}
+
+export interface PromptRetrieveParams {
+  /**
+   * The version of the prompt to get (defaults to latest).
+   */
+  version?: number | null;
+}
+
+export interface PromptUpdateParams {
+  /**
+   * The updated prompt text content.
+   */
+  prompt: string;
+
+  /**
+   * The current version of the prompt being updated.
+   */
+  version: number;
+
+  /**
+   * Set the new version as the default (default=True).
+   */
+  set_as_default?: boolean;
+
+  /**
+   * Updated list of variable names that can be used in the prompt template.
+   */
+  variables?: Array<string> | null;
+}
+
+export interface PromptSetDefaultVersionParams {
+  /**
+   * The version to set as default.
+   */
+  version: number;
+}
+
+Prompts.Versions = Versions;
+
+export declare namespace Prompts {
+  export {
+    type ListPromptsResponse as ListPromptsResponse,
+    type Prompt as Prompt,
+    type PromptListResponse as PromptListResponse,
+    type PromptCreateParams as PromptCreateParams,
+    type PromptRetrieveParams as PromptRetrieveParams,
+    type PromptUpdateParams as PromptUpdateParams,
+    type PromptSetDefaultVersionParams as PromptSetDefaultVersionParams,
+  };
+
+  export { Versions as Versions };
+}

package/dist/src/resources/prompts/versions.ts

@@ -0,0 +1,27 @@
+// 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 PromptsAPI from './prompts';
+
+/**
+ * Protocol for prompt management operations.
+ */
+export class Versions extends APIResource {
+  /**
+   * List all versions of a specific prompt.
+   */
+  list(promptId: string, options?: Core.RequestOptions): Core.APIPromise<PromptsAPI.PromptListResponse> {
+    return (
+      this._client.get(`/v1/prompts/${promptId}/versions`, options) as Core.APIPromise<{
+        data: PromptsAPI.PromptListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}

package/dist/src/resources/prompts.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 './prompts/index';

package/dist/src/resources/providers.ts

@@ -0,0 +1,41 @@
+// 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';
+
+/**
+ * Providers API for inspecting, listing, and modifying providers and their configurations.
+ */
+export class Providers extends APIResource {
+  /**
+   * Get detailed information about a specific provider.
+   */
+  retrieve(providerId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.ProviderInfo> {
+    return this._client.get(`/v1/providers/${providerId}`, options);
+  }
+
+  /**
+   * List all available providers.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<ProviderListResponse> {
+    return (
+      this._client.get('/v1/providers', options) as Core.APIPromise<{ data: ProviderListResponse }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}
+
+/**
+ * List of provider information objects
+ */
+export type ProviderListResponse = Array<Shared.ProviderInfo>;
+
+export declare namespace Providers {
+  export { type ProviderListResponse as ProviderListResponse };
+}

package/dist/src/resources/responses/index.ts

@@ -0,0 +1,26 @@
+// 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 { InputItems, type InputItemListResponse, type InputItemListParams } from './input-items';
+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';