caikit.interfaces.nlp.data_model.sentence_similarity

Data structures for embedding vector representations

Attributes

log

error

Classes

SentenceSimilarityScores

Scores for a sentence similarity task

SentenceSimilarityResult

Result for sentence similarity task

SentenceSimilarityResults

Results list for sentence similarity tasks

Module Contents

caikit.interfaces.nlp.data_model.sentence_similarity.log[source]
caikit.interfaces.nlp.data_model.sentence_similarity.error
class caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityScores[source]

Bases: caikit.core.DataObjectBase

Scores for a sentence similarity task

scores: py_to_proto.dataclass_to_proto.Annotated[List[float], FieldNumber(1)]
class caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityResult[source]

Bases: caikit.core.DataObjectBase

Result for sentence similarity task

result: py_to_proto.dataclass_to_proto.Annotated[SentenceSimilarityScores, FieldNumber(1)]
producer_id: py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(2)]
input_token_count: py_to_proto.dataclass_to_proto.Annotated[int | None, FieldNumber(3)]
class caikit.interfaces.nlp.data_model.sentence_similarity.SentenceSimilarityResults[source]

Bases: caikit.core.DataObjectBase

Results list for sentence similarity tasks

results: py_to_proto.dataclass_to_proto.Annotated[List[SentenceSimilarityScores], FieldNumber(1)]
producer_id: py_to_proto.dataclass_to_proto.Annotated[caikit.interfaces.common.data_model.ProducerId, FieldNumber(2)]
input_token_count: py_to_proto.dataclass_to_proto.Annotated[int | None, FieldNumber(3)]