Skip to content

ontocast.tool.representation_contract

Shared structural contracts for embedding-ready representations.

EmbeddingRepresentation

Bases: Protocol

Structural contract for embedding-oriented text representations.

Source code in ontocast/tool/representation_contract.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class EmbeddingRepresentation(Protocol):
    """Structural contract for embedding-oriented text representations."""

    @property
    def iri(self) -> str | URIRef:
        """IRI of the focal entity represented by this object."""
        ...

    @property
    def ontology_iri(self) -> str | None:
        """Source ontology IRI when known in this representation context."""
        ...

    @property
    def core_representation(self) -> str: ...

    @property
    def neighborhood_representation(self) -> str: ...

    @property
    def representation(self) -> str:
        """Combined representation string view."""
        ...

iri property

IRI of the focal entity represented by this object.

ontology_iri property

Source ontology IRI when known in this representation context.

representation property

Combined representation string view.

combine_embedding_text(value)

Return a canonical combined view for embedding-oriented text objects.

Source code in ontocast/tool/representation_contract.py 
35
36
37
38
39
def combine_embedding_text(value: EmbeddingRepresentation) -> str:
    """Return a canonical combined view for embedding-oriented text objects."""
    if value.neighborhood_representation:
        return f"{value.core_representation}. {value.neighborhood_representation}"
    return value.core_representation