llama-stack-client 0.0.1-alpha.0

package/src/resources/agents/turns.ts

@@ -0,0 +1,231 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { APIPromise } from '../../core';
+import * as Core from '../../core';
+import * as TurnsAPI from './turns';
+import * as Shared from '../shared';
+import * as AgentsAPI from './agents';
+import { Stream } from '../../streaming';
+
+export class Turns extends APIResource {
+  create(
+    params: TurnCreateParamsNonStreaming,
+    options?: Core.RequestOptions,
+  ): APIPromise<AgentsTurnStreamChunk>;
+  create(
+    params: TurnCreateParamsStreaming,
+    options?: Core.RequestOptions,
+  ): APIPromise<Stream<AgentsTurnStreamChunk>>;
+  create(
+    params: TurnCreateParamsBase,
+    options?: Core.RequestOptions,
+  ): APIPromise<Stream<AgentsTurnStreamChunk> | AgentsTurnStreamChunk>;
+  create(
+    params: TurnCreateParams,
+    options?: Core.RequestOptions,
+  ): APIPromise<AgentsTurnStreamChunk> | APIPromise<Stream<AgentsTurnStreamChunk>> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/agents/turn/create', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+      stream: params.stream ?? false,
+    }) as APIPromise<AgentsTurnStreamChunk> | APIPromise<Stream<AgentsTurnStreamChunk>>;
+  }
+
+  retrieve(params: TurnRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Turn> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/agents/turn/get', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface AgentsTurnStreamChunk {
+  event: TurnStreamEvent;
+}
+
+export interface Turn {
+  input_messages: Array<Shared.UserMessage | Shared.ToolResponseMessage>;
+
+  output_attachments: Array<Shared.Attachment>;
+
+  output_message: Shared.CompletionMessage;
+
+  session_id: string;
+
+  started_at: string;
+
+  steps: Array<
+    | AgentsAPI.InferenceStep
+    | AgentsAPI.ToolExecutionStep
+    | AgentsAPI.ShieldCallStep
+    | AgentsAPI.MemoryRetrievalStep
+  >;
+
+  turn_id: string;
+
+  completed_at?: string;
+}
+
+export interface TurnStreamEvent {
+  payload:
+    | TurnStreamEvent.AgentTurnResponseStepStartPayload
+    | TurnStreamEvent.AgentTurnResponseStepProgressPayload
+    | TurnStreamEvent.AgentTurnResponseStepCompletePayload
+    | TurnStreamEvent.AgentTurnResponseTurnStartPayload
+    | TurnStreamEvent.AgentTurnResponseTurnCompletePayload;
+}
+
+export namespace TurnStreamEvent {
+  export interface AgentTurnResponseStepStartPayload {
+    event_type: 'step_start';
+
+    step_id: string;
+
+    step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
+
+    metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+  }
+
+  export interface AgentTurnResponseStepProgressPayload {
+    event_type: 'step_progress';
+
+    step_id: string;
+
+    step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
+
+    model_response_text_delta?: string;
+
+    tool_call_delta?: AgentTurnResponseStepProgressPayload.ToolCallDelta;
+
+    tool_response_text_delta?: string;
+  }
+
+  export namespace AgentTurnResponseStepProgressPayload {
+    export interface ToolCallDelta {
+      content: string | Shared.ToolCall;
+
+      parse_status: 'started' | 'in_progress' | 'failure' | 'success';
+    }
+  }
+
+  export interface AgentTurnResponseStepCompletePayload {
+    event_type: 'step_complete';
+
+    step_details:
+      | AgentsAPI.InferenceStep
+      | AgentsAPI.ToolExecutionStep
+      | AgentsAPI.ShieldCallStep
+      | AgentsAPI.MemoryRetrievalStep;
+
+    step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
+  }
+
+  export interface AgentTurnResponseTurnStartPayload {
+    event_type: 'turn_start';
+
+    turn_id: string;
+  }
+
+  export interface AgentTurnResponseTurnCompletePayload {
+    event_type: 'turn_complete';
+
+    turn: TurnsAPI.Turn;
+  }
+}
+
+export type TurnCreateParams = TurnCreateParamsNonStreaming | TurnCreateParamsStreaming;
+
+export interface TurnCreateParamsBase {
+  /**
+   * Body param:
+   */
+  agent_id: string;
+
+  /**
+   * Body param:
+   */
+  messages: Array<Shared.UserMessage | Shared.ToolResponseMessage>;
+
+  /**
+   * Body param:
+   */
+  session_id: string;
+
+  /**
+   * Body param:
+   */
+  attachments?: Array<Shared.Attachment>;
+
+  /**
+   * Body param:
+   */
+  stream?: boolean;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace TurnCreateParams {
+  export type TurnCreateParamsNonStreaming = TurnsAPI.TurnCreateParamsNonStreaming;
+  export type TurnCreateParamsStreaming = TurnsAPI.TurnCreateParamsStreaming;
+}
+
+export interface TurnCreateParamsNonStreaming extends TurnCreateParamsBase {
+  /**
+   * Body param:
+   */
+  stream?: false;
+}
+
+export interface TurnCreateParamsStreaming extends TurnCreateParamsBase {
+  /**
+   * Body param:
+   */
+  stream: true;
+}
+
+export interface TurnRetrieveParams {
+  /**
+   * Query param:
+   */
+  agent_id: string;
+
+  /**
+   * Query param:
+   */
+  turn_id: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Turns {
+  export import AgentsTurnStreamChunk = TurnsAPI.AgentsTurnStreamChunk;
+  export import Turn = TurnsAPI.Turn;
+  export import TurnStreamEvent = TurnsAPI.TurnStreamEvent;
+  export import TurnCreateParams = TurnsAPI.TurnCreateParams;
+  export import TurnCreateParamsNonStreaming = TurnsAPI.TurnCreateParamsNonStreaming;
+  export import TurnCreateParamsStreaming = TurnsAPI.TurnCreateParamsStreaming;
+  export import TurnRetrieveParams = TurnsAPI.TurnRetrieveParams;
+}

package/src/resources/batch-inference.ts

@@ -0,0 +1,154 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as BatchInferenceAPI from './batch-inference';
+import * as Shared from './shared';
+import * as AgentsAPI from './agents/agents';
+
+export class BatchInference extends APIResource {
+  chatCompletion(
+    params: BatchInferenceChatCompletionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BatchChatCompletion> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/batch_inference/chat_completion', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  completion(
+    params: BatchInferenceCompletionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Shared.BatchCompletion> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/batch_inference/completion', {
+      body,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface BatchChatCompletion {
+  completion_message_batch: Array<Shared.CompletionMessage>;
+}
+
+export interface BatchInferenceChatCompletionParams {
+  /**
+   * Body param:
+   */
+  messages_batch: Array<
+    Array<Shared.UserMessage | Shared.SystemMessage | Shared.ToolResponseMessage | Shared.CompletionMessage>
+  >;
+
+  /**
+   * Body param:
+   */
+  model: string;
+
+  /**
+   * Body param:
+   */
+  logprobs?: BatchInferenceChatCompletionParams.Logprobs;
+
+  /**
+   * Body param:
+   */
+  sampling_params?: Shared.SamplingParams;
+
+  /**
+   * Body param:
+   */
+  tool_choice?: 'auto' | 'required';
+
+  /**
+   * Body param: `json` -- Refers to the json format for calling tools. The json
+   * format takes the form like { "type": "function", "function" : { "name":
+   * "function_name", "description": "function_description", "parameters": {...} } }
+   *
+   * `function_tag` -- This is an example of how you could define your own user
+   * defined format for making tool calls. The function_tag format looks like this,
+   * <function=function_name>(parameters)</function>
+   *
+   * The detailed prompts for each of these formats are added to llama cli
+   */
+  tool_prompt_format?: 'json' | 'function_tag';
+
+  /**
+   * Body param:
+   */
+  tools?: Array<BatchInferenceChatCompletionParams.Tool>;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace BatchInferenceChatCompletionParams {
+  export interface Logprobs {
+    top_k?: number;
+  }
+
+  export interface Tool {
+    tool_name: 'brave_search' | 'wolfram_alpha' | 'photogen' | 'code_interpreter' | (string & {});
+
+    description?: string;
+
+    parameters?: Record<string, AgentsAPI.ToolParamDefinition>;
+  }
+}
+
+export interface BatchInferenceCompletionParams {
+  /**
+   * Body param:
+   */
+  content_batch: Array<string | Array<string>>;
+
+  /**
+   * Body param:
+   */
+  model: string;
+
+  /**
+   * Body param:
+   */
+  logprobs?: BatchInferenceCompletionParams.Logprobs;
+
+  /**
+   * Body param:
+   */
+  sampling_params?: Shared.SamplingParams;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace BatchInferenceCompletionParams {
+  export interface Logprobs {
+    top_k?: number;
+  }
+}
+
+export namespace BatchInference {
+  export import BatchChatCompletion = BatchInferenceAPI.BatchChatCompletion;
+  export import BatchInferenceChatCompletionParams = BatchInferenceAPI.BatchInferenceChatCompletionParams;
+  export import BatchInferenceCompletionParams = BatchInferenceAPI.BatchInferenceCompletionParams;
+}

package/src/resources/datasets.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as DatasetsAPI from './datasets';
+
+export class Datasets extends APIResource {
+  create(params: DatasetCreateParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/datasets/create', {
+      body,
+      ...options,
+      headers: {
+        Accept: '*/*',
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  delete(params: DatasetDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/datasets/delete', {
+      body,
+      ...options,
+      headers: {
+        Accept: '*/*',
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  get(params: DatasetGetParams, options?: Core.RequestOptions): Core.APIPromise<TrainEvalDataset> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/datasets/get', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface TrainEvalDataset {
+  columns: Record<string, 'dialog' | 'text' | 'media' | 'number' | 'json'>;
+
+  content_url: string;
+
+  metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+}
+
+export interface DatasetCreateParams {
+  /**
+   * Body param:
+   */
+  dataset: TrainEvalDataset;
+
+  /**
+   * Body param:
+   */
+  uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface DatasetDeleteParams {
+  /**
+   * Body param:
+   */
+  dataset_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface DatasetGetParams {
+  /**
+   * Query param:
+   */
+  dataset_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Datasets {
+  export import TrainEvalDataset = DatasetsAPI.TrainEvalDataset;
+  export import DatasetCreateParams = DatasetsAPI.DatasetCreateParams;
+  export import DatasetDeleteParams = DatasetsAPI.DatasetDeleteParams;
+  export import DatasetGetParams = DatasetsAPI.DatasetGetParams;
+}

package/src/resources/evaluate/evaluate.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as EvaluateAPI from './evaluate';
+import * as QuestionAnsweringAPI from './question-answering';
+import * as SummarizationAPI from './summarization';
+import * as TextGenerationAPI from './text-generation';
+import * as JobsAPI from './jobs/jobs';
+
+export class Evaluate extends APIResource {
+  jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
+  questionAnswering: QuestionAnsweringAPI.QuestionAnswering = new QuestionAnsweringAPI.QuestionAnswering(
+    this._client,
+  );
+  summarization: SummarizationAPI.Summarization = new SummarizationAPI.Summarization(this._client);
+  textGeneration: TextGenerationAPI.TextGeneration = new TextGenerationAPI.TextGeneration(this._client);
+}
+
+export interface EvaluationJob {
+  job_uuid: string;
+}
+
+export namespace Evaluate {
+  export import EvaluationJob = EvaluateAPI.EvaluationJob;
+  export import Jobs = JobsAPI.Jobs;
+  export import EvaluationJobArtifacts = JobsAPI.EvaluationJobArtifacts;
+  export import EvaluationJobLogStream = JobsAPI.EvaluationJobLogStream;
+  export import EvaluationJobStatus = JobsAPI.EvaluationJobStatus;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobCancelParams = JobsAPI.JobCancelParams;
+  export import QuestionAnswering = QuestionAnsweringAPI.QuestionAnswering;
+  export import QuestionAnsweringCreateParams = QuestionAnsweringAPI.QuestionAnsweringCreateParams;
+  export import Summarization = SummarizationAPI.Summarization;
+  export import TextGeneration = TextGenerationAPI.TextGeneration;
+}

package/src/resources/evaluate/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { EvaluationJob, Evaluate } from './evaluate';
+export {
+  EvaluationJobArtifacts,
+  EvaluationJobLogStream,
+  EvaluationJobStatus,
+  JobListParams,
+  JobCancelParams,
+  Jobs,
+} from './jobs/index';
+export { QuestionAnsweringCreateParams, QuestionAnswering } from './question-answering';
+export { Summarization } from './summarization';
+export { TextGeneration } from './text-generation';

package/src/resources/evaluate/jobs/artifacts.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+import * as ArtifactsAPI from './artifacts';
+import * as JobsAPI from './jobs';
+
+export class Artifacts extends APIResource {
+  list(
+    params: ArtifactListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<JobsAPI.EvaluationJobArtifacts> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...query } = params;
+    return this._client.get('/evaluate/job/artifacts', {
+      query,
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface ArtifactListParams {
+  /**
+   * Query param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Artifacts {
+  export import ArtifactListParams = ArtifactsAPI.ArtifactListParams;
+}

package/src/resources/evaluate/jobs/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { ArtifactListParams, Artifacts } from './artifacts';
+export {
+  EvaluationJobArtifacts,
+  EvaluationJobLogStream,
+  EvaluationJobStatus,
+  JobListParams,
+  JobCancelParams,
+  Jobs,
+} from './jobs';
+export { LogListParams, Logs } from './logs';
+export { StatusListParams, Status } from './status';

package/src/resources/evaluate/jobs/jobs.ts

@@ -0,0 +1,99 @@
+// 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 JobsAPI from './jobs';
+import * as EvaluateAPI from '../evaluate';
+import * as ArtifactsAPI from './artifacts';
+import * as LogsAPI from './logs';
+import * as StatusAPI from './status';
+
+export class Jobs extends APIResource {
+  artifacts: ArtifactsAPI.Artifacts = new ArtifactsAPI.Artifacts(this._client);
+  logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
+  status: StatusAPI.Status = new StatusAPI.Status(this._client);
+
+  list(params?: JobListParams, options?: Core.RequestOptions): Core.APIPromise<EvaluateAPI.EvaluationJob>;
+  list(options?: Core.RequestOptions): Core.APIPromise<EvaluateAPI.EvaluationJob>;
+  list(
+    params: JobListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EvaluateAPI.EvaluationJob> {
+    if (isRequestOptions(params)) {
+      return this.list({}, params);
+    }
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData } = params;
+    return this._client.get('/evaluate/jobs', {
+      ...options,
+      headers: {
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
+  cancel(params: JobCancelParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    const { 'X-LlamaStack-ProviderData': xLlamaStackProviderData, ...body } = params;
+    return this._client.post('/evaluate/job/cancel', {
+      body,
+      ...options,
+      headers: {
+        Accept: '*/*',
+        ...(xLlamaStackProviderData != null ?
+          { 'X-LlamaStack-ProviderData': xLlamaStackProviderData }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+}
+
+export interface EvaluationJobArtifacts {
+  job_uuid: string;
+}
+
+export interface EvaluationJobLogStream {
+  job_uuid: string;
+}
+
+export interface EvaluationJobStatus {
+  job_uuid: string;
+}
+
+export interface JobListParams {
+  /**
+   * JSON-encoded provider data which will be made available to the adapter servicing
+   * the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export interface JobCancelParams {
+  /**
+   * Body param:
+   */
+  job_uuid: string;
+
+  /**
+   * Header param: JSON-encoded provider data which will be made available to the
+   * adapter servicing the API
+   */
+  'X-LlamaStack-ProviderData'?: string;
+}
+
+export namespace Jobs {
+  export import EvaluationJobArtifacts = JobsAPI.EvaluationJobArtifacts;
+  export import EvaluationJobLogStream = JobsAPI.EvaluationJobLogStream;
+  export import EvaluationJobStatus = JobsAPI.EvaluationJobStatus;
+  export import JobListParams = JobsAPI.JobListParams;
+  export import JobCancelParams = JobsAPI.JobCancelParams;
+  export import Artifacts = ArtifactsAPI.Artifacts;
+  export import ArtifactListParams = ArtifactsAPI.ArtifactListParams;
+  export import Logs = LogsAPI.Logs;
+  export import LogListParams = LogsAPI.LogListParams;
+  export import Status = StatusAPI.Status;
+  export import StatusListParams = StatusAPI.StatusListParams;
+}