Skip to content

Latest commit

 

History

History
611 lines (417 loc) · 41.5 KB

api.md

File metadata and controls

611 lines (417 loc) · 41.5 KB

Shared

Types:

Sql

Types:

Methods:

  • client.sql.query({ ...params }) -> SqlQueryResponse

ProductFeedback

Types:

Methods:

  • client.productFeedback.create({ ...params }) -> ProductFeedbackCreateResponse
  • client.productFeedback.retrieve(id) -> ProductFeedbackRetrieveResponse

Agents

Types:

Methods:

  • client.agents.create({ ...params }) -> Agent
  • client.agents.retrieve(agentID, { ...params }) -> Agent
  • client.agents.update(agentID, { ...params }) -> Agent
  • client.agents.list({ ...params }) -> AgentsItemsCursorGetPagination
  • client.agents.delete(agentID) -> void

Fleet

Threads

Types:

Methods:

  • client.fleet.threads.activateSandbox(threadID) -> ThreadActivateSandboxResponse

Sessions

Types:

Methods:

  • client.sessions.create({ ...params }) -> TracerSession
  • client.sessions.retrieve(project_id, { ...params }) -> TracerSession
  • client.sessions.update(project_id, { ...params }) -> TracerSession
  • client.sessions.delete(project_id) -> void
  • client.sessions.createV2({ ...params }) -> Session
  • client.sessions.dashboard(sessionID, { ...params }) -> CustomChartsSection
  • client.sessions.listV2({ ...params }) -> SessionsItemsCursorGetPagination
  • client.sessions.resolve({ ...params }) -> SessionResolveResponse
  • client.sessions.retrieveV2(sessionID, { ...params }) -> Session
  • client.sessions.updateV2(sessionID, { ...params }) -> Session

Datasets

Types:

Methods:

  • client.datasets.listV2({ ...params }) -> DatasetsItemsCursorGetPagination

Examples

Types:

Methods:

  • client.datasets.examples.delete(exampleID, { ...params }) -> void
  • client.datasets.examples.updateMetadata(datasetID, { ...params }) -> ExampleUpdateMetadataResponse

ExperimentRuns

Types:

Methods:

  • client.datasets.experimentRuns.query(datasetID, { ...params }) -> ExperimentRunQueryResponsesItemsCursorPostPagination

Runs

Types:

Methods:

  • client.runs.getURL(runID, { ...params }) -> RunGetURLResponse
  • client.runs.queryV2({ ...params }) -> RunsItemsCursorPostPagination
  • client.runs.retrieveV2(runID, { ...params }) -> Run

Streaming

Types:

Methods:

  • client.runs.streaming.queryV2({ ...params }) -> StreamingQueryV2Response

Share

Types:

Methods:

  • client.runs.share.create(runID, { ...params }) -> ShareCreateResponse
  • client.runs.share.delete(traceID, { ...params }) -> void

Threads

Types:

Methods:

  • client.threads.aggregateStats({ ...params }) -> ThreadAggregateStatsResponse
  • client.threads.listTraces(threadID, { ...params }) -> ThreadTracesItemsCursorGetPagination
  • client.threads.query({ ...params }) -> ThreadsItemsCursorPostPagination
  • client.threads.stats(threadID, { ...params }) -> ThreadStats

Streaming

Types:

Methods:

  • client.threads.streaming.query({ ...params }) -> StreamingQueryResponse

Share

Types:

Methods:

  • client.threads.share.create(threadID, { ...params }) -> ShareCreateResponse
  • client.threads.share.retrieve(threadID, { ...params }) -> ShareRetrieveResponse
  • client.threads.share.delete(threadID, { ...params }) -> void

Traces

Types:

Methods:

  • client.traces.listRuns(traceID, { ...params }) -> TraceListRunsResponse
  • client.traces.query({ ...params }) -> TracesItemsCursorPostPagination

Streaming

Types:

Methods:

  • client.traces.streaming.query({ ...params }) -> StreamingQueryResponse

AISearch

Types:

Methods:

  • client.aiSearch.parse({ ...params }) -> AISearchParseResponse

Evaluators

Types:

Methods:

  • client.evaluators.list({ ...params }) -> EvaluatorListResponse
  • client.evaluators.createDecisionModel({ ...params }) -> Evaluator
  • client.evaluators.listV2({ ...params }) -> RulesItemsCursorGetPagination

OnlineEvaluators

Types:

Methods:

  • client.onlineEvaluators.create({ ...params }) -> CreateOnlineEvaluatorResponse
  • client.onlineEvaluators.retrieve(evaluatorID) -> OnlineEvaluator
  • client.onlineEvaluators.update(evaluatorID, { ...params }) -> UpdateOnlineEvaluatorResponse
  • client.onlineEvaluators.list({ ...params }) -> OnlineEvaluatorsOffsetPaginationOnlineEvaluators
  • client.onlineEvaluators.delete(evaluatorID, { ...params }) -> void
  • client.onlineEvaluators.bulkDelete({ ...params }) -> BulkDeleteEvaluatorsResponse
  • client.onlineEvaluators.spend({ ...params }) -> GetOnlineEvaluatorSpendResponse

Public

Runs

Types:

Methods:

  • client.public.runs.retrieve(runID, { ...params }) -> Run
  • client.public.runs.query(shareToken, { ...params }) -> RunQueryResponse

AnnotationQueues

Types:

Methods:

  • client.annotationQueues.retrieve(queueID) -> AnnotationQueueRetrieveResponse
  • client.annotationQueues.update(queueID, { ...params }) -> unknown
  • client.annotationQueues.delete(queueID) -> unknown
  • client.annotationQueues.annotationQueues({ ...params }) -> AnnotationQueueSchema
  • client.annotationQueues.createRunStatus(annotationQueueRunID, { ...params }) -> unknown
  • client.annotationQueues.export(queueID, { ...params }) -> unknown
  • client.annotationQueues.populate({ ...params }) -> unknown
  • client.annotationQueues.retrieveAnnotationQueues({ ...params }) -> AnnotationQueueRetrieveAnnotationQueuesResponsesOffsetPaginationTopLevelArray
  • client.annotationQueues.retrieveQueues(runID) -> AnnotationQueueRetrieveQueuesResponse
  • client.annotationQueues.retrieveRun(index, { ...params }) -> RunSchemaWithAnnotationQueueInfo
  • client.annotationQueues.retrieveSize(queueID, { ...params }) -> AnnotationQueueSizeSchema
  • client.annotationQueues.retrieveTotalArchived(queueID, { ...params }) -> AnnotationQueueSizeSchema
  • client.annotationQueues.retrieveTotalSize(queueID) -> AnnotationQueueSizeSchema

Runs

Types:

Methods:

  • client.annotationQueues.runs.create(queueID, [ ...body ]) -> RunCreateResponse
  • client.annotationQueues.runs.update(queueRunID, { ...params }) -> unknown
  • client.annotationQueues.runs.list(queueID, { ...params }) -> RunListResponse
  • client.annotationQueues.runs.createByKey(queueID, [ ...body ]) -> RunCreateByKeyResponse
  • client.annotationQueues.runs.deleteAll(queueID, { ...params }) -> unknown
  • client.annotationQueues.runs.deleteQueue(queueRunID, { ...params }) -> unknown

Items

Types:

Methods:

  • client.annotationQueues.items.create(queueID, { ...params }) -> ItemCreateResponse
  • client.annotationQueues.items.update(itemID, { ...params }) -> ItemUpdateResponse
  • client.annotationQueues.items.list(queueID, { ...params }) -> ItemListResponsesItemsCursorGetPagination
  • client.annotationQueues.items.clearFinal(key, { ...params }) -> void
  • client.annotationQueues.items.createStatus(queueItemID, { ...params }) -> ItemCreateStatusResponse
  • client.annotationQueues.items.deleteAll(queueID, { ...params }) -> ItemDeleteAllResponse
  • client.annotationQueues.items.retrieveCount(queueID, { ...params }) -> ItemRetrieveCountResponse
  • client.annotationQueues.items.retrievePlacement(itemID, { ...params }) -> ItemRetrievePlacementResponse
  • client.annotationQueues.items.retrieveReviews(itemID, { ...params }) -> ItemRetrieveReviewsResponse
  • client.annotationQueues.items.setFinal(key, { ...params }) -> ItemSetFinalResponse
  • client.annotationQueues.items.setReview(key, { ...params }) -> AnnotationQueueItemKeyReviews

PromptWebhooks

Types:

Methods:

  • client.promptWebhooks.create({ ...params }) -> PromptWebhook
  • client.promptWebhooks.retrieve(webhookID) -> PromptWebhook
  • client.promptWebhooks.update(webhookID, { ...params }) -> PromptWebhook
  • client.promptWebhooks.list() -> PromptWebhookListResponse
  • client.promptWebhooks.delete(webhookID) -> void
  • client.promptWebhooks.test({ ...params }) -> PromptWebhookTestResponse

Info

Types:

Methods:

  • client.info.list() -> InfoListResponse

WorkspaceSecrets

Types:

Methods:

  • client.workspaceSecrets.list({ ...params }) -> WorkspaceSecretsItemsCursorGetPagination
  • client.workspaceSecrets.delete(key) -> void
  • client.workspaceSecrets.upsert(key, { ...params }) -> WorkspaceSecret

WorkspaceTags

Types:

Methods:

  • client.workspaceTags.list({ ...params }) -> WorkspaceTagListResponse

Keys

Types:

Methods:

  • client.workspaceTags.keys.create({ ...params }) -> TagKey
  • client.workspaceTags.keys.retrieve(tagKeyID) -> TagKey
  • client.workspaceTags.keys.update(tagKeyID, { ...params }) -> TagKey
  • client.workspaceTags.keys.list() -> KeyListResponse
  • client.workspaceTags.keys.delete(tagKeyID) -> void

Values

Types:

Methods:

  • client.workspaceTags.keys.values.create(tagKeyID, { ...params }) -> TagValue
  • client.workspaceTags.keys.values.retrieve(tagValueID, { ...params }) -> TagValue
  • client.workspaceTags.keys.values.update(tagValueID, { ...params }) -> TagValue
  • client.workspaceTags.keys.values.list(tagKeyID) -> ValueListResponse
  • client.workspaceTags.keys.values.delete(tagValueID, { ...params }) -> void

Repos

Types:

Methods:

  • client.repos.create({ ...params }) -> CreateRepoResponse
  • client.repos.retrieve(repo, { ...params }) -> GetRepoResponse
  • client.repos.update(repo, { ...params }) -> GetRepoResponse
  • client.repos.list({ ...params }) -> RepoWithLookupsOffsetPaginationRepos
  • client.repos.delete(repo, { ...params }) -> unknown

Directories

Types:

Methods:

  • client.repos.directories.list(repo, { ...params }) -> DirectoryListResponse
  • client.repos.directories.delete(repo, { ...params }) -> void
  • client.repos.directories.commit(repo, { ...params }) -> DirectoryCommitResponse

Commits

Types:

Methods:

  • client.commits.create(repo, { ...params }) -> CommitCreateResponse
  • client.commits.retrieve(commit, { ...params }) -> CommitRetrieveResponse
  • client.commits.list(repo, { ...params }) -> CommitWithLookupsOffsetPaginationCommits

Issues

Types:

Methods:

  • client.issues.retrieve(id, { ...params }) -> Issue
  • client.issues.list({ ...params }) -> IssuesOffsetPaginationIssues

Sandboxes

Types:

Methods:

  • client.sandboxes.listUsageCosts({ ...params }) -> SandboxListUsageCostsResponsesItemsCursorGetPagination
  • client.sandboxes.retrieveUsage() -> SandboxRetrieveUsageResponse

Boxes

Types:

Methods:

  • client.sandboxes.boxes.create({ ...params }) -> SandboxResponse
  • client.sandboxes.boxes.retrieve(name) -> SandboxResponse
  • client.sandboxes.boxes.update(name, { ...params }) -> SandboxResponse
  • client.sandboxes.boxes.list({ ...params }) -> SandboxResponsesItemsCursorGetPagination
  • client.sandboxes.boxes.delete(name) -> void
  • client.sandboxes.boxes.batchDelete({ ...params }) -> BoxBatchDeleteResponse
  • client.sandboxes.boxes.createSnapshot(name, { ...params }) -> SnapshotResponse
  • client.sandboxes.boxes.deleteServiceURL(name, { ...params }) -> void
  • client.sandboxes.boxes.generateDownloadURL(name, { ...params }) -> DownloadURLResponse
  • client.sandboxes.boxes.generateServiceURL(name, { ...params }) -> ServiceURLResponse
  • client.sandboxes.boxes.getStatus(name) -> SandboxStatusResponse
  • client.sandboxes.boxes.listServiceURLs(name, { ...params }) -> BoxListServiceURLsResponsesItemsCursorGetPagination
  • client.sandboxes.boxes.start(name) -> SandboxResponse
  • client.sandboxes.boxes.stop(name) -> void

Volumes

Types:

Methods:

  • client.sandboxes.volumes.create({ ...params }) -> VolumeResponse
  • client.sandboxes.volumes.retrieve(volume) -> VolumeResponse
  • client.sandboxes.volumes.update(volume, { ...params }) -> VolumeResponse
  • client.sandboxes.volumes.list({ ...params }) -> VolumeResponsesItemsCursorGetPagination
  • client.sandboxes.volumes.delete(volume) -> void
  • client.sandboxes.volumes.clone(volume, { ...params }) -> VolumeResponse

Registries

Types:

Methods:

  • client.sandboxes.registries.create({ ...params }) -> RegistryResponse
  • client.sandboxes.registries.retrieve(name) -> RegistryResponse
  • client.sandboxes.registries.update(name, { ...params }) -> RegistryResponse
  • client.sandboxes.registries.list({ ...params }) -> RegistryListResponse
  • client.sandboxes.registries.delete(name) -> void

Snapshots

Types:

Methods:

  • client.sandboxes.snapshots.create({ ...params }) -> SnapshotResponse
  • client.sandboxes.snapshots.retrieve(snapshotID) -> SnapshotResponse
  • client.sandboxes.snapshots.list({ ...params }) -> SnapshotResponsesItemsCursorGetPagination
  • client.sandboxes.snapshots.delete(snapshotID) -> void
  • client.sandboxes.snapshots.retrieveByName(name) -> SnapshotRetrieveByNameResponse