Package com.azure.cosmos.models

Enum CosmosFullTextScoreScope

java.lang.Object

java.lang.Enum<CosmosFullTextScoreScope>

com.azure.cosmos.models.CosmosFullTextScoreScope

All Implemented Interfaces:

Serializable, Comparable<CosmosFullTextScoreScope>, java.lang.constant.Constable

public enum CosmosFullTextScoreScope
extends Enum<CosmosFullTextScoreScope>

Specifies the scope for computing BM25 statistics used by FullTextScore in hybrid search queries.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	Compute BM25 statistics (term frequency, inverse document frequency, and document length) across all documents in the container, including all physical and logical partitions.
LOCAL	Compute BM25 statistics only over the subset of documents within the partition key values specified in the query.

Method Summary

Modifier and Type	Method	Description
static CosmosFullTextScoreScope	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CosmosFullTextScoreScope[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GLOBAL

public static final CosmosFullTextScoreScope GLOBAL

Compute BM25 statistics (term frequency, inverse document frequency, and document length) across all documents in the container, including all physical and logical partitions. This is the default behavior.

LOCAL

public static final CosmosFullTextScoreScope LOCAL

Compute BM25 statistics only over the subset of documents within the partition key values specified in the query. This is useful for multi-tenant scenarios where scoring should reflect statistics that are accurate for a specific tenant's dataset.

Method Details

values

public static CosmosFullTextScoreScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CosmosFullTextScoreScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null