api.md

Shared

Types:

• AgentConfig
• BatchCompletion
• CompletionMessage
• ContentDelta
• Document
• InterleavedContent
• InterleavedContentItem
• Message
• ParamType
• QueryConfig
• QueryGeneratorConfig
• QueryResult
• ResponseFormat
• ReturnType
• SafetyViolation
• SamplingParams
• ScoringResult
• SystemMessage
• ToolCall
• ToolParamDefinition
• ToolResponseMessage
• URL
• UserMessage

Toolgroups

Types:

• ListToolGroupsResponse
• ToolGroup
• ToolgroupListResponse

Methods:

• client.toolgroups.list() -> ToolgroupListResponse
• client.toolgroups.get(toolgroupId) -> ToolGroup
• client.toolgroups.register({ ...params }) -> void
• client.toolgroups.unregister(toolgroupId) -> void

Tools

Types:

• ListToolsResponse
• Tool
• ToolListResponse

Methods:

• client.tools.list({ ...params }) -> ToolListResponse
• client.tools.get(toolName) -> Tool

ToolRuntime

Types:

• ToolDef
• ToolInvocationResult

Methods:

• client.toolRuntime.invokeTool({ ...params }) -> ToolInvocationResult
• client.toolRuntime.listTools({ ...params }) -> JSONLDecoder<ToolDef>

RagTool

Methods:

• client.toolRuntime.ragTool.insert({ ...params }) -> void
• client.toolRuntime.ragTool.query({ ...params }) -> QueryResult

Agents

Types:

• InferenceStep
• MemoryRetrievalStep
• ShieldCallStep
• ToolExecutionStep
• ToolResponse
• AgentCreateResponse

Methods:

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

Session

Types:

• Session
• SessionCreateResponse

Methods:

• client.agents.session.create(agentId, { ...params }) -> SessionCreateResponse
• client.agents.session.retrieve(agentId, sessionId, { ...params }) -> Session
• client.agents.session.delete(agentId, sessionId) -> void

Steps

Types:

• StepRetrieveResponse

Methods:

• client.agents.steps.retrieve(agentId, sessionId, turnId, stepId) -> StepRetrieveResponse

Turn

Types:

• Turn
• TurnResponseEvent
• TurnResponseEventPayload
• TurnCreateResponse

Methods:

• client.agents.turn.create(agentId, sessionId, { ...params }) -> TurnCreateResponse
• client.agents.turn.retrieve(agentId, sessionId, turnId) -> Turn

BatchInference

Types:

• BatchInferenceChatCompletionResponse

Methods:

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

Datasets

Types:

• ListDatasetsResponse
• DatasetRetrieveResponse
• DatasetListResponse

Methods:

• client.datasets.retrieve(datasetId) -> DatasetRetrieveResponse | null
• client.datasets.list() -> DatasetListResponse
• client.datasets.register({ ...params }) -> void
• client.datasets.unregister(datasetId) -> void

Eval

Types:

• EvalCandidate
• EvalTaskConfig
• EvaluateResponse
• Job

Methods:

• client.eval.evaluateRows(taskId, { ...params }) -> EvaluateResponse
• client.eval.runEval(taskId, { ...params }) -> Job

Jobs

Types:

• JobStatusResponse

Methods:

• client.eval.jobs.retrieve(taskId, jobId) -> EvaluateResponse
• client.eval.jobs.cancel(taskId, jobId) -> void
• client.eval.jobs.status(taskId, jobId) -> JobStatusResponse | null

Inspect

Types:

• HealthInfo
• ProviderInfo
• RouteInfo
• VersionInfo

Methods:

• client.inspect.health() -> HealthInfo
• client.inspect.version() -> VersionInfo

Inference

Types:

• CompletionResponse
• EmbeddingsResponse
• TokenLogProbs
• InferenceChatCompletionResponse
• InferenceCompletionResponse

Methods:

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

VectorIo

Types:

• QueryChunksResponse

Methods:

• client.vectorIo.insert({ ...params }) -> void
• client.vectorIo.query({ ...params }) -> QueryChunksResponse

VectorDBs

Types:

• ListVectorDBsResponse
• VectorDBRetrieveResponse
• VectorDBListResponse
• VectorDBRegisterResponse

Methods:

• client.vectorDBs.retrieve(vectorDBId) -> VectorDBRetrieveResponse | null
• client.vectorDBs.list() -> VectorDBListResponse
• client.vectorDBs.register({ ...params }) -> VectorDBRegisterResponse
• client.vectorDBs.unregister(vectorDBId) -> void

Models

Types:

• ListModelsResponse
• Model
• ModelListResponse

Methods:

• client.models.retrieve(modelId) -> Model | null
• client.models.list() -> ModelListResponse
• client.models.register({ ...params }) -> Model
• client.models.unregister(modelId) -> void

PostTraining

Types:

• AlgorithmConfig
• ListPostTrainingJobsResponse
• PostTrainingJob

Methods:

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

Job

Types:

• JobListResponse
• JobArtifactsResponse
• JobStatusResponse

Methods:

• client.postTraining.job.list() -> JobListResponse
• client.postTraining.job.artifacts({ ...params }) -> JobArtifactsResponse | null
• client.postTraining.job.cancel({ ...params }) -> void
• client.postTraining.job.status({ ...params }) -> JobStatusResponse | null

Providers

Types:

• ListProvidersResponse
• ProviderListResponse

Methods:

• client.providers.list() -> ProviderListResponse

Routes

Types:

• ListRoutesResponse
• RouteListResponse

Methods:

• client.routes.list() -> RouteListResponse

Safety

Types:

• RunShieldResponse

Methods:

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

Shields

Types:

• ListShieldsResponse
• Shield
• ShieldListResponse

Methods:

• client.shields.retrieve(identifier) -> Shield | null
• client.shields.list() -> ShieldListResponse
• client.shields.register({ ...params }) -> Shield

SyntheticDataGeneration

Types:

• SyntheticDataGenerationResponse

Methods:

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

Telemetry

Types:

• Event
• QueryCondition
• QuerySpansResponse
• SpanWithStatus
• Trace
• TelemetryGetSpanResponse
• TelemetryGetSpanTreeResponse
• TelemetryQuerySpansResponse
• TelemetryQueryTracesResponse

Methods:

• client.telemetry.getSpan(traceId, spanId) -> TelemetryGetSpanResponse
• client.telemetry.getSpanTree(spanId, { ...params }) -> TelemetryGetSpanTreeResponse
• client.telemetry.getTrace(traceId) -> Trace
• client.telemetry.logEvent({ ...params }) -> void
• client.telemetry.querySpans({ ...params }) -> TelemetryQuerySpansResponse
• client.telemetry.queryTraces({ ...params }) -> TelemetryQueryTracesResponse
• client.telemetry.saveSpansToDataset({ ...params }) -> void

Datasetio

Types:

• PaginatedRowsResult

Methods:

• client.datasetio.appendRows({ ...params }) -> void
• client.datasetio.getRowsPaginated({ ...params }) -> PaginatedRowsResult

Scoring

Types:

• ScoringScoreResponse
• ScoringScoreBatchResponse

Methods:

• client.scoring.score({ ...params }) -> ScoringScoreResponse
• client.scoring.scoreBatch({ ...params }) -> ScoringScoreBatchResponse

ScoringFunctions

Types:

• ListScoringFunctionsResponse
• ScoringFn
• ScoringFnParams
• ScoringFunctionListResponse

Methods:

• client.scoringFunctions.retrieve(scoringFnId) -> ScoringFn | null
• client.scoringFunctions.list() -> ScoringFunctionListResponse
• client.scoringFunctions.register({ ...params }) -> void

EvalTasks

Types:

• EvalTask
• ListEvalTasksResponse
• EvalTaskListResponse

Methods:

• client.evalTasks.retrieve(evalTaskId) -> EvalTask | null
• client.evalTasks.list() -> EvalTaskListResponse
• client.evalTasks.register({ ...params }) -> void