API reference

Property Regression Models

Data

openprotein.data.DataAPI	API interface for calling AssayData endpoints
openprotein.data.AssayDataset	Future Job for manipulating results

Predictor

openprotein.predictor.PredictorAPI	This class defines a high level interface for accessing the predictors API.
openprotein.predictor.PredictorModel	Class providing predict endpoint for fitted predictor models.

Design

openprotein.design.DesignAPI	Interface for calling Designer endpoints
openprotein.design.DesignFuture	A future object that will hold the results of the design job.

Foundation models

Endpoints

openprotein.embeddings.EmbeddingsAPI

This class defines a high level interface for accessing the embeddings API.

Models

openprotein.embeddings.OpenProteinModel	Class providing inference endpoints for proprietary protein embedding models served by OpenProtein.
openprotein.embeddings.ESMModel	Class providing inference endpoints for Facebook's ESM protein language Models.
openprotein.embeddings.PoETModel	Class for OpenProtein's foundation model PoET - NB.
openprotein.embeddings.SVDModel	Class providing embedding endpoint for SVD models.
openprotein.embeddings.UMAPModel	Class providing embedding endpoint for UMAP models.

Results

openprotein.embeddings.EmbeddingsResultFuture	Future for manipulating results for embeddings-related requests.
openprotein.embeddings.EmbeddingsScoreFuture	Future for manipulating results for embeddings score-related requests.
openprotein.embeddings.EmbeddingsGenerateFuture	Future for manipulating results for embeddings generate-related requests.

Align

openprotein.align.AlignAPI	API interface for calling Poet and Align endpoints
openprotein.align.PromptFuture	Represents a result of a prompt job.
openprotein.align.MSAFuture	Represents a result of a MSA job.

Fold

openprotein.fold.FoldAPI	This class defines a high level interface for accessing the fold API.
openprotein.fold.ESMFoldModel
openprotein.fold.AlphaFold2Model
openprotein.fold.FoldResultFuture	Future Job for manipulating results