llama-stack-client 0.4.3-rc3 → 0.4.4

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

package/dist/src/resources/embeddings.ts

@@ -0,0 +1,84 @@
+// 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 Embeddings extends APIResource {
+  /**
+   * Create embeddings.
+   *
+   * 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 {
+  data: Array<CreateEmbeddingsResponse.Data>;
+
+  model: string;
+
+  /**
+   * Usage information for an OpenAI-compatible embeddings response.
+   */
+  usage: CreateEmbeddingsResponse.Usage;
+
+  object?: 'list';
+}
+
+export namespace CreateEmbeddingsResponse {
+  /**
+   * A single embedding data object from an OpenAI-compatible embeddings response.
+   */
+  export interface Data {
+    embedding: Array<number> | string;
+
+    index: number;
+
+    object?: 'embedding';
+  }
+
+  /**
+   * Usage information for an OpenAI-compatible embeddings response.
+   */
+  export interface Usage {
+    prompt_tokens: number;
+
+    total_tokens: number;
+  }
+}
+
+export interface EmbeddingCreateParams {
+  input: string | Array<string>;
+
+  model: string;
+
+  dimensions?: number | null;
+
+  encoding_format?: string | null;
+
+  user?: string | null;
+
+  [k: string]: unknown;
+}
+
+export declare namespace Embeddings {
+  export {
+    type CreateEmbeddingsResponse as CreateEmbeddingsResponse,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
+  };
+}

package/dist/src/resources/files.ts

@@ -0,0 +1,184 @@
+// 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 { OpenAICursorPage, type OpenAICursorPageParams } from '../pagination';
+
+export class Files extends APIResource {
+  /**
+   * Upload file.
+   *
+   * Upload a file that can be used across various endpoints.
+   *
+   * The file upload should be a multipart form request with:
+   *
+   * - file: The File object (not file name) to be uploaded.
+   * - purpose: The intended purpose of the uploaded file.
+   * - expires_after: Optional form values describing expiration for the file.
+   */
+  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+  }
+
+  /**
+   * Retrieve file.
+   *
+   * Returns information about a specific file.
+   */
+  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
+    return this._client.get(`/v1/files/${fileId}`, options);
+  }
+
+  /**
+   * List files.
+   *
+   * Returns a list of files that belong to the user's organization.
+   */
+  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.
+   *
+   * Returns the contents of the specified file.
+   */
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
+    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 {
+  id: string;
+
+  deleted: boolean;
+
+  object?: 'file';
+}
+
+/**
+ * OpenAI File object as defined in the OpenAI Files API.
+ */
+export interface File {
+  id: string;
+
+  bytes: number;
+
+  created_at: number;
+
+  expires_at: number;
+
+  filename: string;
+
+  /**
+   * Valid purpose values for OpenAI Files API.
+   */
+  purpose: 'assistants' | 'batch';
+
+  object?: 'file';
+}
+
+/**
+ * Response for listing files in OpenAI Files API.
+ */
+export interface ListFilesResponse {
+  data: Array<File>;
+
+  first_id: string;
+
+  has_more: boolean;
+
+  last_id: string;
+
+  object?: 'list';
+}
+
+export type FileContentResponse = unknown;
+
+export interface FileCreateParams {
+  file: Core.Uploadable;
+
+  /**
+   * Valid purpose values for OpenAI Files API.
+   */
+  purpose: 'assistants' | 'batch';
+
+  /**
+   * Control expiration of uploaded files.
+   *
+   * Params:
+   *
+   * - anchor, must be "created_at"
+   * - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
+   */
+  expires_after?: FileCreateParams.ExpiresAfter | null;
+}
+
+export namespace FileCreateParams {
+  /**
+   * Control expiration of uploaded files.
+   *
+   * Params:
+   *
+   * - anchor, must be "created_at"
+   * - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
+   */
+  export interface ExpiresAfter {
+    anchor: 'created_at';
+
+    seconds: number;
+  }
+}
+
+export interface FileListParams extends OpenAICursorPageParams {
+  /**
+   * Sort order for paginated responses.
+   */
+  order?: 'asc' | 'desc' | null;
+
+  /**
+   * Valid purpose values for OpenAI Files API.
+   */
+  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/dist/src/resources/index.ts

@@ -0,0 +1,139 @@
+// 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 './shared';
+export { Alpha } from './alpha/alpha';
+export {
+  BatchListResponsesOpenAICursorPage,
+  Batches,
+  type BatchCreateResponse,
+  type BatchRetrieveResponse,
+  type BatchListResponse,
+  type BatchCancelResponse,
+  type BatchCreateParams,
+  type BatchListParams,
+} from './batches';
+export { Beta } from './beta/beta';
+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, type HealthInfo, type ProviderInfo, type RouteInfo, type VersionInfo } from './inspect';
+export {
+  Models,
+  type ListModelsResponse,
+  type Model,
+  type ModelRetrieveResponse,
+  type ModelListResponse,
+  type ModelRegisterResponse,
+  type ModelRegisterParams,
+} 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 ListProvidersResponse, type ProviderListResponse } from './providers';
+export {
+  ResponseListResponsesOpenAICursorPage,
+  Responses,
+  type ResponseObject,
+  type ResponseObjectStream,
+  type ResponseListResponse,
+  type ResponseDeleteResponse,
+  type ResponseCreateParams,
+  type ResponseCreateParamsNonStreaming,
+  type ResponseCreateParamsStreaming,
+  type ResponseListParams,
+} from './responses/responses';
+export { Routes, type ListRoutesResponse, type RouteListResponse, type RouteListParams } from './routes';
+export { Safety, type RunShieldResponse, type SafetyRunShieldParams } from './safety';
+export {
+  Scoring,
+  type ScoringScoreResponse,
+  type ScoringScoreBatchResponse,
+  type ScoringScoreParams,
+  type ScoringScoreBatchParams,
+} from './scoring';
+export {
+  ScoringFunctions,
+  type ListScoringFunctionsResponse,
+  type ScoringFn,
+  type ScoringFnParams,
+  type ScoringFunctionListResponse,
+  type ScoringFunctionRegisterParams,
+} from './scoring-functions';
+export {
+  Shields,
+  type ListShieldsResponse,
+  type Shield,
+  type ShieldListResponse,
+  type ShieldRegisterParams,
+} from './shields';
+export {
+  ToolRuntime,
+  type ToolDef,
+  type ToolInvocationResult,
+  type ToolRuntimeListToolsResponse,
+  type ToolRuntimeInvokeToolParams,
+  type ToolRuntimeListToolsParams,
+} from './tool-runtime';
+export {
+  Toolgroups,
+  type ListToolGroupsResponse,
+  type ToolGroup,
+  type ToolgroupListResponse,
+  type ToolgroupRegisterParams,
+} from './toolgroups';
+export { Tools, type ToolListResponse, type ToolListParams } from './tools';
+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/dist/src/resources/inspect.ts

@@ -0,0 +1,81 @@
+// 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 Inspect extends APIResource {
+  /**
+   * Get health status.
+   *
+   * Get the current health status of the service.
+   */
+  health(options?: Core.RequestOptions): Core.APIPromise<HealthInfo> {
+    return this._client.get('/v1/health', options);
+  }
+
+  /**
+   * Get version.
+   *
+   * Get the version of the service.
+   */
+  version(options?: Core.RequestOptions): Core.APIPromise<VersionInfo> {
+    return this._client.get('/v1/version', options);
+  }
+}
+
+/**
+ * Health status information for the service.
+ */
+export interface HealthInfo {
+  status: 'OK' | 'Error' | 'Not Implemented';
+}
+
+/**
+ * Information about a registered provider including its configuration and health
+ * status.
+ */
+export interface ProviderInfo {
+  api: string;
+
+  config: { [key: string]: unknown };
+
+  health: { [key: string]: unknown };
+
+  provider_id: string;
+
+  provider_type: string;
+}
+
+/**
+ * Information about an API route including its path, method, and implementing
+ * providers.
+ */
+export interface RouteInfo {
+  method: string;
+
+  provider_types: Array<string>;
+
+  route: string;
+}
+
+/**
+ * Version information for the service.
+ */
+export interface VersionInfo {
+  version: string;
+}
+
+export declare namespace Inspect {
+  export {
+    type HealthInfo as HealthInfo,
+    type ProviderInfo as ProviderInfo,
+    type RouteInfo as RouteInfo,
+    type VersionInfo as VersionInfo,
+  };
+}

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

@@ -0,0 +1,18 @@
+// 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 {
+  Models,
+  type ListModelsResponse,
+  type Model,
+  type ModelRetrieveResponse,
+  type ModelListResponse,
+  type ModelRegisterResponse,
+  type ModelRegisterParams,
+} from './models';
+export { OpenAI } from './openai';

package/dist/src/resources/models/models.ts

@@ -0,0 +1,179 @@
+// 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 OpenAIAPI from './openai';
+import { OpenAI } from './openai';
+
+export class Models extends APIResource {
+  openai: OpenAIAPI.OpenAI = new OpenAIAPI.OpenAI(this._client);
+
+  /**
+   * Get model.
+   *
+   * 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<ModelListResponse> {
+    return (
+      this._client.get('/v1/models', options) as Core.APIPromise<{ data: ModelListResponse }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Register model.
+   *
+   * Register a model.
+   *
+   * @deprecated
+   */
+  register(body: ModelRegisterParams, options?: Core.RequestOptions): Core.APIPromise<ModelRegisterResponse> {
+    return this._client.post('/v1/models', { body, ...options });
+  }
+
+  /**
+   * Unregister model.
+   *
+   * Unregister a model.
+   *
+   * @deprecated
+   */
+  unregister(modelId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/models/${modelId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface ListModelsResponse {
+  data: ModelListResponse;
+}
+
+/**
+ * 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: Llama Stack-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 Llama Stack.
+ */
+export interface ModelRetrieveResponse {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * Any additional metadata for this model
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Enumeration of supported model types in Llama Stack.
+   */
+  model_type?: 'llm' | 'embedding' | 'rerank';
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'model';
+}
+
+export type ModelListResponse = Array<Model>;
+
+/**
+ * A model resource representing an AI model registered in Llama Stack.
+ */
+export interface ModelRegisterResponse {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
+
+  /**
+   * Any additional metadata for this model
+   */
+  metadata?: { [key: string]: unknown };
+
+  /**
+   * Enumeration of supported model types in Llama Stack.
+   */
+  model_type?: 'llm' | 'embedding' | 'rerank';
+
+  /**
+   * Unique identifier for this resource in the provider
+   */
+  provider_resource_id?: string | null;
+
+  type?: 'model';
+}
+
+export interface ModelRegisterParams {
+  model_id: string;
+
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * Enumeration of supported model types in Llama Stack.
+   */
+  model_type?: 'llm' | 'embedding' | 'rerank' | null;
+
+  provider_id?: string | null;
+
+  provider_model_id?: string | null;
+}
+
+Models.OpenAI = OpenAI;
+
+export declare namespace Models {
+  export {
+    type ListModelsResponse as ListModelsResponse,
+    type Model as Model,
+    type ModelRetrieveResponse as ModelRetrieveResponse,
+    type ModelListResponse as ModelListResponse,
+    type ModelRegisterResponse as ModelRegisterResponse,
+    type ModelRegisterParams as ModelRegisterParams,
+  };
+
+  export { OpenAI as OpenAI };
+}