llama-stack-client 0.4.3 → 0.4.4

package/dist/src/resources/responses.ts

@@ -0,0 +1,9 @@
+// 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.
+
+export * from './responses/index';

package/dist/src/resources/routes.ts

@@ -0,0 +1,56 @@
+// 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 { isRequestOptions } from '../core';
+import * as Core from '../core';
+import * as InspectAPI from './inspect';
+
+export class Routes extends APIResource {
+  /**
+   * List routes.
+   *
+   * List all available API routes with their methods and implementing providers.
+   */
+  list(query?: RouteListParams, options?: Core.RequestOptions): Core.APIPromise<RouteListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<RouteListResponse>;
+  list(
+    query: RouteListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RouteListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return (
+      this._client.get('/v1/inspect/routes', { query, ...options }) as Core.APIPromise<{
+        data: RouteListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}
+
+/**
+ * Response containing a list of all available API routes.
+ */
+export interface ListRoutesResponse {
+  data: RouteListResponse;
+}
+
+export type RouteListResponse = Array<InspectAPI.RouteInfo>;
+
+export interface RouteListParams {
+  api_filter?: 'v1' | 'v1alpha' | 'v1beta' | 'deprecated' | null;
+}
+
+export declare namespace Routes {
+  export {
+    type ListRoutesResponse as ListRoutesResponse,
+    type RouteListResponse as RouteListResponse,
+    type RouteListParams as RouteListParams,
+  };
+}

package/dist/src/resources/safety.ts

@@ -0,0 +1,241 @@
+// 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';
+import * as Shared from './shared';
+
+export class Safety extends APIResource {
+  /**
+   * Run shield.
+   *
+   * Run a shield.
+   */
+  runShield(body: SafetyRunShieldParams, options?: Core.RequestOptions): Core.APIPromise<RunShieldResponse> {
+    return this._client.post('/v1/safety/run-shield', { body, ...options });
+  }
+}
+
+/**
+ * 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 {
+  messages: Array<
+    | SafetyRunShieldParams.OpenAIUserMessageParamInput
+    | SafetyRunShieldParams.OpenAISystemMessageParam
+    | SafetyRunShieldParams.OpenAIAssistantMessageParamInput
+    | SafetyRunShieldParams.OpenAIToolMessageParam
+    | SafetyRunShieldParams.OpenAIDeveloperMessageParam
+  >;
+
+  params: { [key: string]: unknown };
+
+  shield_id: string;
+}
+
+export namespace SafetyRunShieldParams {
+  /**
+   * A message from the user in an OpenAI-compatible chat completion request.
+   */
+  export interface OpenAIUserMessageParamInput {
+    content:
+      | string
+      | Array<
+          | OpenAIUserMessageParamInput.OpenAIChatCompletionContentPartTextParam
+          | OpenAIUserMessageParamInput.OpenAIChatCompletionContentPartImageParam
+          | OpenAIUserMessageParamInput.OpenAIFile
+        >;
+
+    name?: string | null;
+
+    role?: 'user';
+  }
+
+  export namespace OpenAIUserMessageParamInput {
+    /**
+     * Text content part for OpenAI-compatible chat completion messages.
+     */
+    export interface OpenAIChatCompletionContentPartTextParam {
+      text: string;
+
+      type?: 'text';
+    }
+
+    /**
+     * Image content part for OpenAI-compatible chat completion messages.
+     */
+    export interface OpenAIChatCompletionContentPartImageParam {
+      /**
+       * Image URL specification for OpenAI-compatible chat completion messages.
+       */
+      image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
+
+      type?: 'image_url';
+    }
+
+    export namespace OpenAIChatCompletionContentPartImageParam {
+      /**
+       * Image URL specification for OpenAI-compatible chat completion messages.
+       */
+      export interface ImageURL {
+        url: string;
+
+        detail?: string | null;
+      }
+    }
+
+    export interface OpenAIFile {
+      file: OpenAIFile.File;
+
+      type?: 'file';
+    }
+
+    export namespace OpenAIFile {
+      export interface File {
+        file_data?: string | null;
+
+        file_id?: string | null;
+
+        filename?: string | null;
+      }
+    }
+  }
+
+  /**
+   * A system message providing instructions or context to the model.
+   */
+  export interface OpenAISystemMessageParam {
+    content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+
+    name?: string | null;
+
+    role?: 'system';
+  }
+
+  export namespace OpenAISystemMessageParam {
+    /**
+     * Text content part for OpenAI-compatible chat completion messages.
+     */
+    export interface ListOpenAIChatCompletionContentPartTextParam {
+      text: string;
+
+      type?: 'text';
+    }
+  }
+
+  /**
+   * A message containing the model's (assistant) response in an OpenAI-compatible
+   * chat completion request.
+   */
+  export interface OpenAIAssistantMessageParamInput {
+    content?:
+      | string
+      | Array<OpenAIAssistantMessageParamInput.ListOpenAIChatCompletionContentPartTextParam>
+      | null;
+
+    name?: string | null;
+
+    role?: 'assistant';
+
+    tool_calls?: Array<OpenAIAssistantMessageParamInput.ToolCall> | null;
+  }
+
+  export namespace OpenAIAssistantMessageParamInput {
+    /**
+     * Text content part for OpenAI-compatible chat completion messages.
+     */
+    export interface ListOpenAIChatCompletionContentPartTextParam {
+      text: string;
+
+      type?: 'text';
+    }
+
+    /**
+     * Tool call specification for OpenAI-compatible chat completion responses.
+     */
+    export interface ToolCall {
+      id?: string | null;
+
+      /**
+       * Function call details for OpenAI-compatible tool calls.
+       */
+      function?: ToolCall.Function | null;
+
+      index?: number | null;
+
+      type?: 'function';
+    }
+
+    export namespace ToolCall {
+      /**
+       * Function call details for OpenAI-compatible tool calls.
+       */
+      export interface Function {
+        arguments?: string | null;
+
+        name?: string | null;
+      }
+    }
+  }
+
+  /**
+   * A message representing the result of a tool invocation in an OpenAI-compatible
+   * chat completion request.
+   */
+  export interface OpenAIToolMessageParam {
+    content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+
+    tool_call_id: string;
+
+    role?: 'tool';
+  }
+
+  export namespace OpenAIToolMessageParam {
+    /**
+     * Text content part for OpenAI-compatible chat completion messages.
+     */
+    export interface ListOpenAIChatCompletionContentPartTextParam {
+      text: string;
+
+      type?: 'text';
+    }
+  }
+
+  /**
+   * A message from the developer in an OpenAI-compatible chat completion request.
+   */
+  export interface OpenAIDeveloperMessageParam {
+    content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
+
+    name?: string | null;
+
+    role?: 'developer';
+  }
+
+  export namespace OpenAIDeveloperMessageParam {
+    /**
+     * Text content part for OpenAI-compatible chat completion messages.
+     */
+    export interface ListOpenAIChatCompletionContentPartTextParam {
+      text: string;
+
+      type?: 'text';
+    }
+  }
+}
+
+export declare namespace Safety {
+  export { type RunShieldResponse as RunShieldResponse, type SafetyRunShieldParams as SafetyRunShieldParams };
+}

package/dist/src/resources/scoring-functions.ts

@@ -0,0 +1,343 @@
+// 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 ScoringFunctions extends APIResource {
+  /**
+   * Get a scoring function by its ID.
+   */
+  retrieve(scoringFnId: string, options?: Core.RequestOptions): Core.APIPromise<ScoringFn> {
+    return this._client.get(`/v1/scoring-functions/${scoringFnId}`, options);
+  }
+
+  /**
+   * List all scoring functions.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<ScoringFunctionListResponse> {
+    return (
+      this._client.get('/v1/scoring-functions', options) as Core.APIPromise<{
+        data: ScoringFunctionListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Register a scoring function.
+   *
+   * @deprecated
+   */
+  register(body: ScoringFunctionRegisterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/v1/scoring-functions', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Unregister a scoring function.
+   *
+   * @deprecated
+   */
+  unregister(scoringFnId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/scoring-functions/${scoringFnId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface ListScoringFunctionsResponse {
+  data: ScoringFunctionListResponse;
+}
+
+/**
+ * A scoring function resource for evaluating model outputs.
+ */
+export interface ScoringFn {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  return_type: ScoringFn.ReturnType;
+
+  description?: string | null;
+
+  /**
+   * Any additional metadata for this definition
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * The parameters for the scoring function for benchmark eval, these can be
+   * overridden for app eval
+   */
+  params?:
+    | ScoringFn.LlmAsJudgeScoringFnParams
+    | ScoringFn.RegexParserScoringFnParams
+    | ScoringFn.BasicScoringFnParams
+    | null;
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'scoring_function';
+}
+
+export namespace ScoringFn {
+  export interface ReturnType {
+    type:
+      | 'string'
+      | 'number'
+      | 'boolean'
+      | 'array'
+      | 'object'
+      | 'json'
+      | 'union'
+      | 'chat_completion_input'
+      | 'completion_input'
+      | 'agent_turn_input';
+  }
+
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
+  export interface LlmAsJudgeScoringFnParams {
+    judge_model: string;
+
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regexes to extract the answer from generated response
+     */
+    judge_score_regexes?: Array<string>;
+
+    prompt_template?: string | null;
+
+    type?: 'llm_as_judge';
+  }
+
+  /**
+   * Parameters for regex parser scoring function configuration.
+   */
+  export interface RegexParserScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regex to extract the answer from generated response
+     */
+    parsing_regexes?: Array<string>;
+
+    type?: 'regex_parser';
+  }
+
+  /**
+   * Parameters for basic scoring function configuration.
+   */
+  export interface BasicScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    type?: 'basic';
+  }
+}
+
+/**
+ * Parameters for LLM-as-judge scoring function configuration.
+ */
+export type ScoringFnParams =
+  | ScoringFnParams.LlmAsJudgeScoringFnParams
+  | ScoringFnParams.RegexParserScoringFnParams
+  | ScoringFnParams.BasicScoringFnParams;
+
+export namespace ScoringFnParams {
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
+  export interface LlmAsJudgeScoringFnParams {
+    judge_model: string;
+
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regexes to extract the answer from generated response
+     */
+    judge_score_regexes?: Array<string>;
+
+    prompt_template?: string | null;
+
+    type?: 'llm_as_judge';
+  }
+
+  /**
+   * Parameters for regex parser scoring function configuration.
+   */
+  export interface RegexParserScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regex to extract the answer from generated response
+     */
+    parsing_regexes?: Array<string>;
+
+    type?: 'regex_parser';
+  }
+
+  /**
+   * Parameters for basic scoring function configuration.
+   */
+  export interface BasicScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    type?: 'basic';
+  }
+}
+
+export type ScoringFunctionListResponse = Array<ScoringFn>;
+
+export interface ScoringFunctionRegisterParams {
+  description: string;
+
+  return_type: ScoringFunctionRegisterParams.ReturnType;
+
+  scoring_fn_id: string;
+
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
+  params?:
+    | ScoringFunctionRegisterParams.LlmAsJudgeScoringFnParams
+    | ScoringFunctionRegisterParams.RegexParserScoringFnParams
+    | ScoringFunctionRegisterParams.BasicScoringFnParams
+    | null;
+
+  provider_id?: string | null;
+
+  provider_scoring_fn_id?: string | null;
+}
+
+export namespace ScoringFunctionRegisterParams {
+  export interface ReturnType {
+    type:
+      | 'string'
+      | 'number'
+      | 'boolean'
+      | 'array'
+      | 'object'
+      | 'json'
+      | 'union'
+      | 'chat_completion_input'
+      | 'completion_input'
+      | 'agent_turn_input';
+  }
+
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
+  export interface LlmAsJudgeScoringFnParams {
+    judge_model: string;
+
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regexes to extract the answer from generated response
+     */
+    judge_score_regexes?: Array<string>;
+
+    prompt_template?: string | null;
+
+    type?: 'llm_as_judge';
+  }
+
+  /**
+   * Parameters for regex parser scoring function configuration.
+   */
+  export interface RegexParserScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    /**
+     * Regex to extract the answer from generated response
+     */
+    parsing_regexes?: Array<string>;
+
+    type?: 'regex_parser';
+  }
+
+  /**
+   * Parameters for basic scoring function configuration.
+   */
+  export interface BasicScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
+    aggregation_functions?: Array<
+      'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
+    >;
+
+    type?: 'basic';
+  }
+}
+
+export declare namespace ScoringFunctions {
+  export {
+    type ListScoringFunctionsResponse as ListScoringFunctionsResponse,
+    type ScoringFn as ScoringFn,
+    type ScoringFnParams as ScoringFnParams,
+    type ScoringFunctionListResponse as ScoringFunctionListResponse,
+    type ScoringFunctionRegisterParams as ScoringFunctionRegisterParams,
+  };
+}