ogx-client 0.7.2-rc1

package/resources/safety.d.ts

@@ -0,0 +1,297 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as Shared from "./shared.js";
+/**
+ * OpenAI-compatible Moderations API.
+ */
+export declare class Safety extends APIResource {
+    /**
+     * Run a safety shield on messages to check for policy violations.
+     */
+    runShield(body: SafetyRunShieldParams, options?: Core.RequestOptions): Core.APIPromise<RunShieldResponse>;
+}
+/**
+ * Response from running a safety shield.
+ */
+export interface RunShieldResponse {
+    /**
+     * Details of a safety violation detected by content moderation.
+     */
+    violation?: Shared.SafetyViolation | null;
+}
+export interface SafetyRunShieldParams {
+    /**
+     * The messages to run the shield on
+     */
+    messages: Array<SafetyRunShieldParams.OpenAIUserMessageParamInput | SafetyRunShieldParams.OpenAISystemMessageParam | SafetyRunShieldParams.OpenAIAssistantMessageParamInput | SafetyRunShieldParams.OpenAIToolMessageParam | SafetyRunShieldParams.OpenAIDeveloperMessageParam>;
+    /**
+     * The identifier of the shield to run
+     */
+    shield_id: string;
+}
+export declare namespace SafetyRunShieldParams {
+    /**
+     * A message from the user in an OpenAI-compatible chat completion request.
+     */
+    interface OpenAIUserMessageParamInput {
+        /**
+         * The content of the message, which can include text and other media.
+         */
+        content: string | Array<OpenAIUserMessageParamInput.OpenAIChatCompletionContentPartTextParam | OpenAIUserMessageParamInput.OpenAIChatCompletionContentPartImageParam | OpenAIUserMessageParamInput.OpenAIFile>;
+        /**
+         * The name of the user message participant.
+         */
+        name?: string | null;
+        /**
+         * Must be 'user' to identify this as a user message.
+         */
+        role?: 'user';
+    }
+    namespace OpenAIUserMessageParamInput {
+        /**
+         * Text content part for OpenAI-compatible chat completion messages.
+         */
+        interface OpenAIChatCompletionContentPartTextParam {
+            /**
+             * The text content of the message.
+             */
+            text: string;
+            /**
+             * Must be 'text' to identify this as text content.
+             */
+            type?: 'text';
+        }
+        /**
+         * Image content part for OpenAI-compatible chat completion messages.
+         */
+        interface OpenAIChatCompletionContentPartImageParam {
+            /**
+             * Image URL specification and processing details.
+             */
+            image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
+            /**
+             * Must be 'image_url' to identify this as image content.
+             */
+            type?: 'image_url';
+        }
+        namespace OpenAIChatCompletionContentPartImageParam {
+            /**
+             * Image URL specification and processing details.
+             */
+            interface ImageURL {
+                /**
+                 * URL of the image to include in the message.
+                 */
+                url: string;
+                /**
+                 * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
+                 */
+                detail?: 'low' | 'high' | 'auto' | null;
+            }
+        }
+        /**
+         * File content part for OpenAI-compatible chat completion messages.
+         */
+        interface OpenAIFile {
+            /**
+             * File specification.
+             */
+            file: OpenAIFile.File;
+            /**
+             * Must be 'file' to identify this as file content.
+             */
+            type?: 'file';
+        }
+        namespace OpenAIFile {
+            /**
+             * File specification.
+             */
+            interface File {
+                /**
+                 * Base64-encoded file data.
+                 */
+                file_data?: string | null;
+                /**
+                 * ID of an uploaded file.
+                 */
+                file_id?: string | null;
+                /**
+                 * Name of the file.
+                 */
+                filename?: string | null;
+            }
+        }
+    }
+    /**
+     * A system message providing instructions or context to the model.
+     */
+    interface OpenAISystemMessageParam {
+        /**
+         * The content of the 'system prompt'. If multiple system messages are provided,
+         * they are concatenated.
+         */
+        content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+        /**
+         * The name of the system message participant.
+         */
+        name?: string | null;
+        /**
+         * Must be 'system' to identify this as a system message.
+         */
+        role?: 'system';
+    }
+    namespace OpenAISystemMessageParam {
+        /**
+         * Text content part for OpenAI-compatible chat completion messages.
+         */
+        interface ListOpenAIChatCompletionContentPartTextParam {
+            /**
+             * The text content of the message.
+             */
+            text: string;
+            /**
+             * Must be 'text' to identify this as text content.
+             */
+            type?: 'text';
+        }
+    }
+    /**
+     * A message containing the model's (assistant) response in an OpenAI-compatible
+     * chat completion request.
+     */
+    interface OpenAIAssistantMessageParamInput {
+        /**
+         * The content of the model's response.
+         */
+        content?: string | Array<OpenAIAssistantMessageParamInput.ListOpenAIChatCompletionContentPartTextParam> | null;
+        /**
+         * The name of the assistant message participant.
+         */
+        name?: string | null;
+        /**
+         * Must be 'assistant' to identify this as the model's response.
+         */
+        role?: 'assistant';
+        /**
+         * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
+         */
+        tool_calls?: Array<OpenAIAssistantMessageParamInput.ToolCall> | null;
+        [k: string]: unknown;
+    }
+    namespace OpenAIAssistantMessageParamInput {
+        /**
+         * Text content part for OpenAI-compatible chat completion messages.
+         */
+        interface ListOpenAIChatCompletionContentPartTextParam {
+            /**
+             * The text content of the message.
+             */
+            text: string;
+            /**
+             * Must be 'text' to identify this as text content.
+             */
+            type?: 'text';
+        }
+        /**
+         * Tool call specification for OpenAI-compatible chat completion responses.
+         */
+        interface ToolCall {
+            /**
+             * Unique identifier for the tool call.
+             */
+            id: string;
+            /**
+             * Function call details.
+             */
+            function: ToolCall.Function;
+            /**
+             * Must be 'function' to identify this as a function call.
+             */
+            type: 'function';
+        }
+        namespace ToolCall {
+            /**
+             * Function call details.
+             */
+            interface Function {
+                /**
+                 * Arguments to pass to the function as a JSON string.
+                 */
+                arguments: string;
+                /**
+                 * Name of the function to call.
+                 */
+                name: string;
+            }
+        }
+    }
+    /**
+     * A message representing the result of a tool invocation in an OpenAI-compatible
+     * chat completion request.
+     */
+    interface OpenAIToolMessageParam {
+        /**
+         * The response content from the tool.
+         */
+        content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+        /**
+         * Unique identifier for the tool call this response is for.
+         */
+        tool_call_id: string;
+        /**
+         * Must be 'tool' to identify this as a tool response.
+         */
+        role?: 'tool';
+    }
+    namespace OpenAIToolMessageParam {
+        /**
+         * Text content part for OpenAI-compatible chat completion messages.
+         */
+        interface ListOpenAIChatCompletionContentPartTextParam {
+            /**
+             * The text content of the message.
+             */
+            text: string;
+            /**
+             * Must be 'text' to identify this as text content.
+             */
+            type?: 'text';
+        }
+    }
+    /**
+     * A message from the developer in an OpenAI-compatible chat completion request.
+     */
+    interface OpenAIDeveloperMessageParam {
+        /**
+         * The content of the developer message.
+         */
+        content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+        /**
+         * The name of the developer message participant.
+         */
+        name?: string | null;
+        /**
+         * Must be 'developer' to identify this as a developer message.
+         */
+        role?: 'developer';
+    }
+    namespace OpenAIDeveloperMessageParam {
+        /**
+         * Text content part for OpenAI-compatible chat completion messages.
+         */
+        interface ListOpenAIChatCompletionContentPartTextParam {
+            /**
+             * The text content of the message.
+             */
+            text: string;
+            /**
+             * Must be 'text' to identify this as text content.
+             */
+            type?: 'text';
+        }
+    }
+}
+export declare namespace Safety {
+    export { type RunShieldResponse as RunShieldResponse, type SafetyRunShieldParams as SafetyRunShieldParams };
+}
+//# sourceMappingURL=safety.d.ts.map

package/resources/safety.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety.d.ts","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAG1G;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,KAAK,CACX,qBAAqB,CAAC,2BAA2B,GACjD,qBAAqB,CAAC,wBAAwB,GAC9C,qBAAqB,CAAC,gCAAgC,GACtD,qBAAqB,CAAC,sBAAsB,GAC5C,qBAAqB,CAAC,2BAA2B,CACpD,CAAC;IAEF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EACH,MAAM,GACN,KAAK,CACD,2BAA2B,CAAC,wCAAwC,GACpE,2BAA2B,CAAC,yCAAyC,GACrE,2BAA2B,CAAC,UAAU,CACzC,CAAC;QAEN;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,wCAAwC;YACvD;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,yCAAyC;YACxD;;eAEG;YACH,SAAS,EAAE,yCAAyC,CAAC,QAAQ,CAAC;YAE9D;;eAEG;YACH,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB;QAED,UAAiB,yCAAyC,CAAC;YACzD;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,GAAG,EAAE,MAAM,CAAC;gBAEZ;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;aACzC;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;YAEtB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED,UAAiB,UAAU,CAAC;YAC1B;;eAEG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE1B;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAExB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aAC1B;SACF;KACF;IAED;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,4CAA4C,CAAC,CAAC;QAE/F;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED,UAAiB,wBAAwB,CAAC;QACxC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;;OAGG;IACH,UAAiB,gCAAgC;QAC/C;;WAEG;QACH,OAAO,CAAC,EACJ,MAAM,GACN,KAAK,CAAC,gCAAgC,CAAC,4CAA4C,CAAC,GACpF,IAAI,CAAC;QAET;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QAErE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,gCAAgC,CAAC;QAChD;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;YAE5B;;eAEG;YACH,IAAI,EAAE,UAAU,CAAC;SAClB;QAED,UAAiB,QAAQ,CAAC;YACxB;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,SAAS,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;aACd;SACF;KACF;IAED;;;OAGG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,sBAAsB,CAAC,4CAA4C,CAAC,CAAC;QAE7F;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,sBAAsB,CAAC;QACtC;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,2BAA2B,CAAC,4CAA4C,CAAC,CAAC;QAElG;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,4CAA4C;YAC3D;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAC7G"}

package/resources/safety.js

@@ -0,0 +1,24 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Safety = void 0;
+const resource_1 = require("../resource.js");
+/**
+ * OpenAI-compatible Moderations API.
+ */
+class Safety extends resource_1.APIResource {
+    /**
+     * Run a safety shield on messages to check for policy violations.
+     */
+    runShield(body, options) {
+        return this._client.post('/v1/safety/run-shield', { body, ...options });
+    }
+}
+exports.Safety = Safety;
+//# sourceMappingURL=safety.js.map

package/resources/safety.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety.js","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;AAEtF,6CAA0C;AAI1C;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAPD,wBAOC"}

package/resources/safety.mjs

@@ -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.mjs";
+/**
+ * OpenAI-compatible Moderations API.
+ */
+export class Safety extends APIResource {
+    /**
+     * Run a safety shield on messages to check for policy violations.
+     */
+    runShield(body, options) {
+        return this._client.post('/v1/safety/run-shield', { body, ...options });
+    }
+}
+//# sourceMappingURL=safety.mjs.map

package/resources/safety.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"safety.mjs","sourceRoot":"","sources":["../src/resources/safety.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,SAAS,CAAC,IAA2B,EAAE,OAA6B;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF"}