api.md

Shared

Types:

• AISecret
• ACL
• ACLBatchUpdateResponse
• APIKey
• ChatCompletionContentPartImage
• ChatCompletionContentPartText
• ChatCompletionMessageToolCall
• CodeBundle
• CreateAPIKeyOutput
• CrossObjectInsertResponse
• DataSummary
• Dataset
• DatasetEvent
• EnvVar
• Experiment
• ExperimentEvent
• FeedbackDatasetItem
• FeedbackExperimentItem
• FeedbackProjectLogsItem
• FeedbackResponseSchema
• FetchDatasetEventsResponse
• FetchExperimentEventsResponse
• FetchProjectLogsEventsResponse
• Function
• FunctionToolChoice
• Group
• InsertDatasetEventMerge
• InsertDatasetEventReplace
• InsertEventsResponse
• InsertExperimentEventMerge
• InsertExperimentEventReplace
• InsertProjectLogsEventMerge
• InsertProjectLogsEventReplace
• MetricSummary
• OnlineScoreConfig
• Organization
• PatchOrganizationMembersOutput
• PathLookupFilter
• Project
• ProjectLogsEvent
• ProjectScore
• ProjectScoreCategory
• ProjectScoreConfig
• ProjectScoreType
• ProjectSettings
• ProjectTag
• Prompt
• PromptData
• RepoInfo
• Role
• ScoreSummary
• Scorer
• SummarizeDatasetResponse
• SummarizeExperimentResponse
• Task
• ToolChoice
• User
• View
• ViewData
• ViewDataSearch
• ViewOptions

TopLevel

Types:

• TopLevelHelloWorldResponse

Methods:

• client.topLevel.helloWorld() -> string

Projects

Methods:

• client.projects.create({ ...params }) -> Project
• client.projects.retrieve(projectId) -> Project
• client.projects.update(projectId, { ...params }) -> Project
• client.projects.list({ ...params }) -> ProjectsListObjects
• client.projects.delete(projectId) -> Project

Logs

Methods:

• client.projects.logs.feedback(projectId, { ...params }) -> FeedbackResponseSchema
• client.projects.logs.fetch(projectId, { ...params }) -> FetchProjectLogsEventsResponse
• client.projects.logs.fetchPost(projectId, { ...params }) -> FetchProjectLogsEventsResponse
• client.projects.logs.insert(projectId, { ...params }) -> InsertEventsResponse

Experiments

Methods:

• client.experiments.create({ ...params }) -> Experiment
• client.experiments.retrieve(experimentId) -> Experiment
• client.experiments.update(experimentId, { ...params }) -> Experiment
• client.experiments.list({ ...params }) -> ExperimentsListObjects
• client.experiments.delete(experimentId) -> Experiment
• client.experiments.feedback(experimentId, { ...params }) -> FeedbackResponseSchema
• client.experiments.fetch(experimentId, { ...params }) -> FetchExperimentEventsResponse
• client.experiments.fetchPost(experimentId, { ...params }) -> FetchExperimentEventsResponse
• client.experiments.insert(experimentId, { ...params }) -> InsertEventsResponse
• client.experiments.summarize(experimentId, { ...params }) -> SummarizeExperimentResponse

Datasets

Methods:

• client.datasets.create({ ...params }) -> Dataset
• client.datasets.retrieve(datasetId) -> Dataset
• client.datasets.update(datasetId, { ...params }) -> Dataset
• client.datasets.list({ ...params }) -> DatasetsListObjects
• client.datasets.delete(datasetId) -> Dataset
• client.datasets.feedback(datasetId, { ...params }) -> FeedbackResponseSchema
• client.datasets.fetch(datasetId, { ...params }) -> FetchDatasetEventsResponse
• client.datasets.fetchPost(datasetId, { ...params }) -> FetchDatasetEventsResponse
• client.datasets.insert(datasetId, { ...params }) -> InsertEventsResponse
• client.datasets.summarize(datasetId, { ...params }) -> SummarizeDatasetResponse

Prompts

Methods:

• client.prompts.create({ ...params }) -> Prompt
• client.prompts.retrieve(promptId) -> Prompt
• client.prompts.update(promptId, { ...params }) -> Prompt
• client.prompts.list({ ...params }) -> PromptsListObjects
• client.prompts.delete(promptId) -> Prompt
• client.prompts.replace({ ...params }) -> Prompt

Roles

Methods:

• client.roles.create({ ...params }) -> Role
• client.roles.retrieve(roleId) -> Role
• client.roles.update(roleId, { ...params }) -> Role
• client.roles.list({ ...params }) -> RolesListObjects
• client.roles.delete(roleId) -> Role
• client.roles.replace({ ...params }) -> Role

Groups

Methods:

• client.groups.create({ ...params }) -> Group
• client.groups.retrieve(groupId) -> Group
• client.groups.update(groupId, { ...params }) -> Group
• client.groups.list({ ...params }) -> GroupsListObjects
• client.groups.delete(groupId) -> Group
• client.groups.replace({ ...params }) -> Group

ACLs

Methods:

• client.acls.create({ ...params }) -> ACL
• client.acls.retrieve(aclId) -> ACL
• client.acls.list({ ...params }) -> ACLsListObjects
• client.acls.delete(aclId) -> ACL
• client.acls.batchUpdate({ ...params }) -> ACLBatchUpdateResponse
• client.acls.findAndDelete({ ...params }) -> ACL

Users

Methods:

• client.users.retrieve(userId) -> User
• client.users.list({ ...params }) -> UsersListObjects

ProjectScores

Methods:

• client.projectScores.create({ ...params }) -> ProjectScore
• client.projectScores.retrieve(projectScoreId) -> ProjectScore
• client.projectScores.update(projectScoreId, { ...params }) -> ProjectScore
• client.projectScores.list({ ...params }) -> ProjectScoresListObjects
• client.projectScores.delete(projectScoreId) -> ProjectScore
• client.projectScores.replace({ ...params }) -> ProjectScore

ProjectTags

Methods:

• client.projectTags.create({ ...params }) -> ProjectTag
• client.projectTags.retrieve(projectTagId) -> ProjectTag
• client.projectTags.update(projectTagId, { ...params }) -> ProjectTag
• client.projectTags.list({ ...params }) -> ProjectTagsListObjects
• client.projectTags.delete(projectTagId) -> ProjectTag
• client.projectTags.replace({ ...params }) -> ProjectTag

Functions

Types:

• FunctionInvokeResponse

Methods:

• client.functions.create({ ...params }) -> Function
• client.functions.retrieve(functionId) -> Function
• client.functions.update(functionId, { ...params }) -> Function
• client.functions.list({ ...params }) -> FunctionsListObjects
• client.functions.delete(functionId) -> Function
• client.functions.invoke(functionId, { ...params }) -> unknown
• client.functions.replace({ ...params }) -> Function

Views

Methods:

• client.views.create({ ...params }) -> View
• client.views.retrieve(viewId, { ...params }) -> View
• client.views.update(viewId, { ...params }) -> View
• client.views.list({ ...params }) -> ViewsListObjects
• client.views.delete(viewId, { ...params }) -> View
• client.views.replace({ ...params }) -> View

Organizations

Methods:

• client.organizations.retrieve(organizationId) -> Organization
• client.organizations.update(organizationId, { ...params }) -> Organization
• client.organizations.list({ ...params }) -> OrganizationsListObjects
• client.organizations.delete(organizationId) -> Organization

Members

Methods:

• client.organizations.members.update({ ...params }) -> PatchOrganizationMembersOutput

APIKeys

Methods:

• client.apiKeys.create({ ...params }) -> CreateAPIKeyOutput
• client.apiKeys.retrieve(apiKeyId) -> APIKey
• client.apiKeys.list({ ...params }) -> APIKeysListObjects
• client.apiKeys.delete(apiKeyId) -> APIKey

AISecrets

Methods:

• client.aiSecrets.create({ ...params }) -> AISecret
• client.aiSecrets.retrieve(aiSecretId) -> AISecret
• client.aiSecrets.update(aiSecretId, { ...params }) -> AISecret
• client.aiSecrets.list({ ...params }) -> AISecretsListObjects
• client.aiSecrets.delete(aiSecretId) -> AISecret
• client.aiSecrets.findAndDelete({ ...params }) -> AISecret
• client.aiSecrets.replace({ ...params }) -> AISecret

EnvVars

Types:

• EnvVarListResponse

Methods:

• client.envVars.create({ ...params }) -> EnvVar
• client.envVars.retrieve(envVarId) -> EnvVar
• client.envVars.update(envVarId, { ...params }) -> EnvVar
• client.envVars.list({ ...params }) -> EnvVarListResponse
• client.envVars.delete(envVarId) -> EnvVar
• client.envVars.replace({ ...params }) -> EnvVar

Evals

Methods:

• client.evals.create({ ...params }) -> SummarizeExperimentResponse