Package dev.braintrust.api

Class BraintrustApiClient.HttpImpl

java.lang.Object

dev.braintrust.api.BraintrustApiClient.HttpImpl

All Implemented Interfaces:

BraintrustApiClient

Enclosing interface:

BraintrustApiClient

public static class BraintrustApiClient.HttpImpl
extends Object
implements BraintrustApiClient

Nested Class Summary

Nested classes/interfaces inherited from interface dev.braintrust.api.BraintrustApiClient

BraintrustApiClient.CreateDatasetRequest, BraintrustApiClient.CreateExperimentRequest, BraintrustApiClient.CreateProjectRequest, BraintrustApiClient.Dataset, BraintrustApiClient.DatasetEvent, BraintrustApiClient.DatasetList, BraintrustApiClient.Experiment, BraintrustApiClient.ExperimentList, BraintrustApiClient.HttpImpl, BraintrustApiClient.InMemoryImpl, BraintrustApiClient.InsertEventsRequest, BraintrustApiClient.InsertEventsResponse, BraintrustApiClient.LoginRequest, BraintrustApiClient.LoginResponse, BraintrustApiClient.OrganizationAndProjectInfo, BraintrustApiClient.OrganizationInfo, BraintrustApiClient.Project, BraintrustApiClient.ProjectList, BraintrustApiClient.Prompt, BraintrustApiClient.PromptData, BraintrustApiClient.PromptListResponse

Method Summary

Modifier and Type	Method	Description
BraintrustApiClient.Experiment	getOrCreateExperiment(BraintrustApiClient.CreateExperimentRequest request)	Creates an experiment.
BraintrustApiClient.Project	getOrCreateProject(String projectName)	Creates or gets a project by name.
BraintrustApiClient.OrganizationAndProjectInfo	getOrCreateProjectAndOrgInfo(BraintrustConfig config)	Get project and org info for the given config.
Optional<BraintrustApiClient.Project>	getProject(String projectId)	Gets a project by ID.
Optional<BraintrustApiClient.OrganizationAndProjectInfo>	getProjectAndOrgInfo()	Get project and org info for the default project ID
Optional<BraintrustApiClient.OrganizationAndProjectInfo>	getProjectAndOrgInfo(String projectId)	Get project and org info for the given project ID
Optional<BraintrustApiClient.Prompt>	getPrompt(String projectName, String slug, String version)	Get a prompt by slug and optional version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getOrCreateProject

public BraintrustApiClient.Project getOrCreateProject(String projectName)

Description copied from interface: BraintrustApiClient

Creates or gets a project by name.

Specified by:

getOrCreateProject in interface BraintrustApiClient

getProject

public Optional<BraintrustApiClient.Project> getProject(String projectId)

Description copied from interface: BraintrustApiClient

Gets a project by ID.

Specified by:

getProject in interface BraintrustApiClient

getOrCreateExperiment

public BraintrustApiClient.Experiment getOrCreateExperiment(BraintrustApiClient.CreateExperimentRequest request)

Description copied from interface: BraintrustApiClient

Creates an experiment.

Specified by:

getOrCreateExperiment in interface BraintrustApiClient

getProjectAndOrgInfo

public Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo()

Description copied from interface: BraintrustApiClient

Get project and org info for the default project ID

Specified by:

getProjectAndOrgInfo in interface BraintrustApiClient

getProjectAndOrgInfo

public Optional<BraintrustApiClient.OrganizationAndProjectInfo> getProjectAndOrgInfo(String projectId)

Description copied from interface: BraintrustApiClient

Get project and org info for the given project ID

Specified by:

getProjectAndOrgInfo in interface BraintrustApiClient

getOrCreateProjectAndOrgInfo

public BraintrustApiClient.OrganizationAndProjectInfo getOrCreateProjectAndOrgInfo(BraintrustConfig config)

Description copied from interface: BraintrustApiClient

Get project and org info for the given config. Creating them if necessary

Specified by:

getOrCreateProjectAndOrgInfo in interface BraintrustApiClient

getPrompt

public Optional<BraintrustApiClient.Prompt> getPrompt(@Nonnull
 String projectName,
 @Nonnull
 String slug,
 @Nullable
 String version)

Description copied from interface: BraintrustApiClient

Get a prompt by slug and optional version

Specified by:

getPrompt in interface BraintrustApiClient