SemanticSearchNode

public SemanticSearchNode(int vectorIndex)

Constructor for SemanticSearchNode representing the semanticSearch function in a query.

By default:

• The default set by the user and returned by getDefaultEmbeddingSearchMetricType will be used to determine similarity between embedding vectors. If no default is set, cosine similarity will be used.
• The upper bound on similarity scores for an embedding vector such that the associated document will be returned is positive infinity.
• The lower bound on similarity scores for an embedding vector such that the associated document will be returned is negative infinity.

See SemanticSearchNode for an explanation of the parameters.

public SemanticSearchNode(int vectorIndex, float lowerBound)

Constructor for SemanticSearchNode representing the semanticSearch function in a query.

By default:

• The default set by the user and returned by getDefaultEmbeddingSearchMetricType will be used to determine similarity between embedding vectors. If no default is set, cosine similarity will be used.
• The upper bound on similarity scores for an embedding vector such that the associated document will be returned is positive infinity.

See SemanticSearchNode for an explanation of the parameters.

public SemanticSearchNode(int vectorIndex, float lowerBound, float upperBound)

Constructor for SemanticSearchNode representing the semanticSearch function in a query.

By default:

• The default set by the user and returned by getDefaultEmbeddingSearchMetricType will be used to determine similarity between embedding vectors. If no default is set, cosine similarity will be used.

See SemanticSearchNode for an explanation of the parameters.

public SemanticSearchNode(
    int vectorIndex,
    float lowerBound,
    float upperBound,
    int distanceMetric
)

Constructor for SemanticSearchNode representing the semanticSearch function in a query.

public int getDistanceMetric()

Returns the distance metric used to calculated similarity between embedding vectors.

public @NonNull String getFunctionName()

Returns the name of the function represented by SemanticSearchNode.

public float getLowerBound()

Returns the lower bound of the range of values similarity scores must fall in.

public float getUpperBound()

Returns the upper bound of the range of values similarity scores must fall in.

public int getVectorIndex()

Returns the index of the embedding vector used in semanticSearch.

public void setBounds(float lowerBound, float upperBound)

Sets the bounds of the range of values that semanticSearch will search against.

public void setDistanceMetric(int distanceMetric)

Sets how similarity is calculated between embedding vectors.

public void setVectorIndex(int vectorIndex)

Sets the index of the embedding vector that semanticSearch will use.

public @NonNull String toString()

Get the query string representation of SemanticSearchNode.

The query string representation will be the function name, followed by the fields of SemanticSearchNode as arguments, surrounded by parentheses, but formatted in the following way:

• The vector index will appear as an argument to the function `getEmbeddingParameter`.
• The lower bound and upper bound will appear unchanged.
• The distance metric will be mapped to its corresponding string literal representation. For example, if the distance metric is 1, then the corresponding string literal would be "COSINE".

If possible, default parameters will be left out of the query string. For example the node SemanticSearchNode(0) will look like `semanticSearch(getEmbeddingParameter(0))`. However if some defaults are set and unset, the defaults will be included in the query string. For example, if the user does something like this:

SemanticSearchNode semanticSearchNode = new SemanticSearchNode(0, -1, 1);
semanticSearchNode.setBounds(Float.NEGATIVE_INFINITY, 1);