Package com.basistech.rosette.dm

Class Embeddings

java.lang.Object

com.basistech.rosette.dm.BaseAttribute

com.basistech.rosette.dm.Embeddings

All Implemented Interfaces:

Serializable

public class Embeddings
extends BaseAttribute
implements Serializable

Embeddings for a text. A text can have embedding values for the entire text and/or one of more of the collections of items inside the text, such as the tokens or entities. The collections are identified by strings. Constants are provided for some common cases.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Embeddings.Builder
static enum	Embeddings.Name	The embedding name.

Field Summary

Fields inherited from class com.basistech.rosette.dm.BaseAttribute

extendedProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Embeddings(Map<Embeddings.Name,EmbeddingCollection> collections, Map<String,Object> extendedProperties)

Method Summary

Modifier and Type	Method	Description
EmbeddingCollection	get(Embeddings.Name collectionName)	Retrieve the embeddings, if any, for a particular collection.
Map<Embeddings.Name,EmbeddingCollection>	getCollections()	Retrieve all of the collections as a map.
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()

Methods inherited from class com.basistech.rosette.dm.BaseAttribute

getExtendedProperties, listOrNull, setExtendedProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Embeddings

protected Embeddings(Map<Embeddings.Name,EmbeddingCollection> collections,
 Map<String,Object> extendedProperties)

Method Details

get

public EmbeddingCollection get(Embeddings.Name collectionName)

Retrieve the embeddings, if any, for a particular collection.

Parameters:

collectionName - The collection name.

Returns:

the embeddings.

getCollections

public Map<Embeddings.Name,EmbeddingCollection> getCollections()

Retrieve all of the collections as a map.

Returns:

the collections.

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()

Overrides:

toStringHelper in class BaseAttribute