Class ExploreControls
java.lang.Object
co.elastic.clients.elasticsearch.graph.ExploreControls
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ExploreControls>
Json deserializer forExploreControls
-
Method Summary
Modifier and TypeMethodDescriptionstatic ExploreControls
final SampleDiversity
To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample.final Integer
Each hop considers a sample of the best-matching documents on each shard.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final Time
timeout()
The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned.toString()
final boolean
Required - Filters associated terms so only those that are significantly associated with your query are included.
-
Field Details
-
_DESERIALIZER
Json deserializer forExploreControls
-
-
Method Details
-
of
public static ExploreControls of(Function<ExploreControls.Builder, ObjectBuilder<ExploreControls>> fn) -
sampleDiversity
To avoid the top-matching documents sample being dominated by a single source of results, it is sometimes necessary to request diversity in the sample. You can do this by selecting a single-value field and setting a maximum number of documents per value for that field.API name:
sample_diversity
-
sampleSize
Each hop considers a sample of the best-matching documents on each shard. Using samples improves the speed of execution and keeps exploration focused on meaningfully-connected terms. Very small values (less than 50) might not provide sufficient weight-of-evidence to identify significant connections between terms. Very large sample sizes can dilute the quality of the results and increase execution times.API name:
sample_size
-
timeout
The length of time in milliseconds after which exploration will be halted and the results gathered so far are returned. This timeout is honored on a best-effort basis. Execution might overrun this timeout if, for example, a long pause is encountered while FieldData is loaded for a field.API name:
timeout
-
useSignificance
public final boolean useSignificance()Required - Filters associated terms so only those that are significantly associated with your query are included.API name:
use_significance
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupExploreControlsDeserializer
protected static void setupExploreControlsDeserializer(ObjectDeserializer<ExploreControls.Builder> op)
-