get_text_embedding

get_text_embedding(reference, *, model=None)[source]

Get a text embedding for an entity, or return none if no text is available.

Parameters:
  • reference (str | curies.Reference | curies.ReferenceTuple) – A reference, either as a string or Reference object

  • model (sentence_transformers.SentenceTransformer | None) – A sentence transformer model. Defaults to all-MiniLM-L6-v2 if not given.

Returns:

A 1D numpy float array of embeddings from sentence_transformers

Return type:

np.ndarray[tuple[int], np.dtype[np.float64]] | None

import pyobo

embedding = pyobo.get_text_embedding("GO:0000001")
# [-5.68335280e-02  7.96175096e-03 -3.36112119e-02  2.34440481e-03 ... ]

If you want to do multiple operations, load up the model for reuse

import pyobo
from pyobo.api.embedding import get_text_embedding_model

model = get_text_embedding_model()
embedding = pyobo.get_text_embedding("GO:0000001", model=model)
# [-5.68335280e-02  7.96175096e-03 -3.36112119e-02  2.34440481e-03 ... ]