api.md

Shared

Types:

• Attachment
• BatchCompletion
• CompletionMessage
• SamplingParams
• SystemMessage
• ToolCall
• ToolResponseMessage
• UserMessage

Telemetry

Types:

• TelemetryGetTraceResponse

Methods:

• client.telemetry.getTrace({ ...params }) -> TelemetryGetTraceResponse
• client.telemetry.log({ ...params }) -> void

Agents

Types:

• InferenceStep
• MemoryRetrievalStep
• RestAPIExecutionConfig
• ShieldCallStep
• ToolExecutionStep
• ToolParamDefinition
• AgentCreateResponse

Methods:

• client.agents.create({ ...params }) -> AgentCreateResponse
• client.agents.delete({ ...params }) -> void

Sessions

Types:

• Session
• SessionCreateResponse

Methods:

• client.agents.sessions.create({ ...params }) -> SessionCreateResponse
• client.agents.sessions.retrieve({ ...params }) -> Session
• client.agents.sessions.delete({ ...params }) -> void

Steps

Types:

• AgentsStep

Methods:

• client.agents.steps.retrieve({ ...params }) -> AgentsStep

Turns

Types:

• AgentsTurnStreamChunk
• Turn
• TurnStreamEvent

Methods:

• client.agents.turns.create({ ...params }) -> AgentsTurnStreamChunk
• client.agents.turns.retrieve({ ...params }) -> Turn

Datasets

Types:

• TrainEvalDataset

Methods:

• client.datasets.create({ ...params }) -> void
• client.datasets.delete({ ...params }) -> void
• client.datasets.get({ ...params }) -> TrainEvalDataset

Evaluate

Types:

• EvaluationJob

Jobs

Types:

• EvaluationJobArtifacts
• EvaluationJobLogStream
• EvaluationJobStatus

Methods:

• client.evaluate.jobs.list({ ...params }) -> EvaluationJob
• client.evaluate.jobs.cancel({ ...params }) -> void

Artifacts

Methods:

• client.evaluate.jobs.artifacts.list({ ...params }) -> EvaluationJobArtifacts

Logs

Methods:

• client.evaluate.jobs.logs.list({ ...params }) -> EvaluationJobLogStream

Status

Methods:

• client.evaluate.jobs.status.list({ ...params }) -> EvaluationJobStatus

QuestionAnswering

Methods:

• client.evaluate.questionAnswering.create({ ...params }) -> EvaluationJob

Summarization

TextGeneration

Evaluations

Methods:

• client.evaluations.summarization({ ...params }) -> EvaluationJob
• client.evaluations.textGeneration({ ...params }) -> EvaluationJob

Inference

Types:

• ChatCompletionStreamChunk
• CompletionStreamChunk
• TokenLogProbs
• InferenceChatCompletionResponse
• InferenceCompletionResponse

Methods:

• client.inference.chatCompletion({ ...params }) -> InferenceChatCompletionResponse
• client.inference.completion({ ...params }) -> InferenceCompletionResponse

Embeddings

Types:

• Embeddings

Methods:

• client.inference.embeddings.create({ ...params }) -> Embeddings

Safety

Types:

• RunSheidResponse

Methods:

• client.safety.runShield({ ...params }) -> RunSheidResponse

Memory

Types:

• QueryDocuments
• MemoryCreateResponse
• MemoryRetrieveResponse
• MemoryListResponse
• MemoryDropResponse

Methods:

• client.memory.create({ ...params }) -> unknown
• client.memory.retrieve({ ...params }) -> unknown
• client.memory.update({ ...params }) -> void
• client.memory.list({ ...params }) -> unknown
• client.memory.drop({ ...params }) -> string
• client.memory.insert({ ...params }) -> void
• client.memory.query({ ...params }) -> QueryDocuments

Documents

Types:

• DocumentRetrieveResponse

Methods:

• client.memory.documents.retrieve({ ...params }) -> DocumentRetrieveResponse
• client.memory.documents.delete({ ...params }) -> void

PostTraining

Types:

• PostTrainingJob

Methods:

• client.postTraining.preferenceOptimize({ ...params }) -> PostTrainingJob
• client.postTraining.supervisedFineTune({ ...params }) -> PostTrainingJob

Jobs

Types:

• PostTrainingJobArtifacts
• PostTrainingJobLogStream
• PostTrainingJobStatus

Methods:

• client.postTraining.jobs.list({ ...params }) -> PostTrainingJob
• client.postTraining.jobs.artifacts({ ...params }) -> PostTrainingJobArtifacts
• client.postTraining.jobs.cancel({ ...params }) -> void
• client.postTraining.jobs.logs({ ...params }) -> PostTrainingJobLogStream
• client.postTraining.jobs.status({ ...params }) -> PostTrainingJobStatus

RewardScoring

Types:

• RewardScoring
• ScoredDialogGenerations

Methods:

• client.rewardScoring.score({ ...params }) -> RewardScoring

SyntheticDataGeneration

Types:

• SyntheticDataGeneration

Methods:

• client.syntheticDataGeneration.generate({ ...params }) -> SyntheticDataGeneration

BatchInference

Types:

• BatchChatCompletion

Methods:

• client.batchInference.chatCompletion({ ...params }) -> BatchChatCompletion
• client.batchInference.completion({ ...params }) -> BatchCompletion

Models

Types:

• ModelServingSpec

Methods:

• client.models.list({ ...params }) -> ModelServingSpec
• client.models.get({ ...params }) -> ModelServingSpec | null

MemoryBanks

Types:

• MemoryBankSpec

Methods:

• client.memoryBanks.list({ ...params }) -> MemoryBankSpec
• client.memoryBanks.get({ ...params }) -> MemoryBankSpec | null

Shields

Types:

• ShieldSpec

Methods:

• client.shields.list({ ...params }) -> ShieldSpec
• client.shields.get({ ...params }) -> ShieldSpec | null