ogx-client 0.7.2-rc1

package/src/resources/alpha/benchmarks.ts

@@ -0,0 +1,152 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// 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';
+
+export class Benchmarks extends APIResource {
+  /**
+   * Get a benchmark by its ID.
+   */
+  retrieve(benchmarkId: string, options?: Core.RequestOptions): Core.APIPromise<Benchmark> {
+    return this._client.get(`/v1alpha/eval/benchmarks/${benchmarkId}`, options);
+  }
+
+  /**
+   * List all benchmarks.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<BenchmarkListResponse> {
+    return (
+      this._client.get('/v1alpha/eval/benchmarks', options) as Core.APIPromise<{
+        data: BenchmarkListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Register a benchmark.
+   *
+   * @deprecated
+   */
+  register(body: BenchmarkRegisterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/v1alpha/eval/benchmarks', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Unregister a benchmark.
+   *
+   * @deprecated
+   */
+  unregister(benchmarkId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1alpha/eval/benchmarks/${benchmarkId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+/**
+ * A benchmark resource for evaluating model performance.
+ */
+export interface Benchmark {
+  /**
+   * Identifier of the dataset to use for the benchmark evaluation.
+   */
+  dataset_id: string;
+
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * List of scoring function identifiers to apply during evaluation.
+   */
+  scoring_functions: Array<string>;
+
+  /**
+   * Metadata for this evaluation task.
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  /**
+   * The resource type, always benchmark.
+   */
+  type?: 'benchmark';
+}
+
+/**
+ * Response containing a list of benchmark objects.
+ */
+export interface ListBenchmarksResponse {
+  /**
+   * List of benchmark objects.
+   */
+  data: BenchmarkListResponse;
+}
+
+/**
+ * List of benchmark objects.
+ */
+export type BenchmarkListResponse = Array<Benchmark>;
+
+export interface BenchmarkRegisterParams {
+  /**
+   * The ID of the benchmark to register.
+   */
+  benchmark_id: string;
+
+  /**
+   * The ID of the dataset to use for the benchmark.
+   */
+  dataset_id: string;
+
+  /**
+   * The scoring functions to use for the benchmark.
+   */
+  scoring_functions: Array<string>;
+
+  /**
+   * The metadata to use for the benchmark.
+   */
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * The ID of the provider benchmark to use for the benchmark.
+   */
+  provider_benchmark_id?: string | null;
+
+  /**
+   * The ID of the provider to use for the benchmark.
+   */
+  provider_id?: string | null;
+}
+
+export declare namespace Benchmarks {
+  export {
+    type Benchmark as Benchmark,
+    type ListBenchmarksResponse as ListBenchmarksResponse,
+    type BenchmarkListResponse as BenchmarkListResponse,
+    type BenchmarkRegisterParams as BenchmarkRegisterParams,
+  };
+}

package/src/resources/alpha/index.ts

@@ -0,0 +1,11 @@
+// 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 { Admin, type AdminListRoutesParams } from './admin';
+export { Alpha } from './alpha';
+export { Inference, type InferenceRerankResponse, type InferenceRerankParams } from './inference';

package/src/resources/alpha/inference.ts

@@ -0,0 +1,191 @@
+// 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 Inference extends APIResource {
+  /**
+   * Rerank a list of documents based on their relevance to a query.
+   */
+  rerank(
+    body: InferenceRerankParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InferenceRerankResponse> {
+    return (
+      this._client.post('/v1alpha/inference/rerank', { body, ...options }) as Core.APIPromise<{
+        data: InferenceRerankResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}
+
+/**
+ * List of rerank result objects, sorted by relevance score (descending).
+ */
+export type InferenceRerankResponse = Array<InferenceRerankResponse.InferenceRerankResponseItem>;
+
+export namespace InferenceRerankResponse {
+  /**
+   * A single rerank result from a reranking response.
+   */
+  export interface InferenceRerankResponseItem {
+    /**
+     * The original index of the document in the input list.
+     */
+    index: number;
+
+    /**
+     * The relevance score from the model output. Higher scores indicate greater
+     * relevance.
+     */
+    relevance_score: number;
+  }
+}
+
+export interface InferenceRerankParams {
+  /**
+   * List of items to rerank. Each item can be a string, text content part, or image
+   * content part.
+   */
+  items: Array<
+    | string
+    | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
+    | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam
+  >;
+
+  /**
+   * The identifier of the reranking model to use.
+   */
+  model: string;
+
+  /**
+   * The search query to rank items against. Can be a string, text content part, or
+   * image content part.
+   */
+  query:
+    | string
+    | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
+    | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam;
+
+  /**
+   * Maximum number of results to return. Default: returns all.
+   */
+  max_num_results?: number | null;
+}
+
+export namespace InferenceRerankParams {
+  /**
+   * Text content part for OpenAI-compatible chat completion messages.
+   */
+  export 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.
+   */
+  export 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';
+  }
+
+  export namespace OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification and processing details.
+     */
+    export 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;
+    }
+  }
+
+  /**
+   * Text content part for OpenAI-compatible chat completion messages.
+   */
+  export 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.
+   */
+  export 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';
+  }
+
+  export namespace OpenAIChatCompletionContentPartImageParam {
+    /**
+     * Image URL specification and processing details.
+     */
+    export 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;
+    }
+  }
+}
+
+export declare namespace Inference {
+  export {
+    type InferenceRerankResponse as InferenceRerankResponse,
+    type InferenceRerankParams as InferenceRerankParams,
+  };
+}

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