Package org.opensearch.client.opensearch._types.query_dsl

Class AgenticQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.AgenticQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<AgenticQuery.Builder,AgenticQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class AgenticQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<AgenticQuery.Builder,AgenticQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgenticQuery.Builder	Builder for AgenticQuery.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<AgenticQuery>	_DESERIALIZER	Json deserializer for AgenticQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
static AgenticQuery.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	memoryId()	The memory ID from a previous response, used to continue a conversation with prior context.
static AgenticQuery	of(Function<AgenticQuery.Builder,ObjectBuilder<AgenticQuery>> fn)
final List<String>	queryFields()	A list of index fields that the agent should consider when generating the search query.
final String	queryText()	Required - The natural language question to be answered by the agent.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAgenticQueryDeserializer(ObjectDeserializer<AgenticQuery.Builder> op)
AgenticQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

toQuery

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<AgenticQuery> _DESERIALIZER

Json deserializer for AgenticQuery

Method Details

of

public static AgenticQuery of(Function<AgenticQuery.Builder,ObjectBuilder<AgenticQuery>> fn)

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

memoryId

@Nullable
public final String memoryId()

The memory ID from a previous response, used to continue a conversation with prior context. Applicable for conversational agents only.

API name: memory_id

queryFields

@Nonnull
public final List<String> queryFields()

A list of index fields that the agent should consider when generating the search query.

API name: query_fields

queryText

@Nonnull
public final String queryText()

Required - The natural language question to be answered by the agent.

API name: query_text

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public AgenticQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AgenticQuery.Builder,AgenticQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static AgenticQuery.Builder builder()

setupAgenticQueryDeserializer

protected static void setupAgenticQueryDeserializer(ObjectDeserializer<AgenticQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase