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

Class AgenticQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<AgenticQuery.Builder>

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

All Implemented Interfaces:

CopyableBuilder<AgenticQuery.Builder,AgenticQuery>, MutableBuilder<AgenticQuery.Builder,AgenticQuery>, ObjectBuilder<AgenticQuery>

Enclosing class:

AgenticQuery

public static class AgenticQuery.Builder
extends QueryBase.AbstractBuilder<AgenticQuery.Builder>
implements CopyableBuilder<AgenticQuery.Builder,AgenticQuery>

Builder for AgenticQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AgenticQuery	build()	Builds a AgenticQuery.
AgenticQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AgenticQuery.Builder	memoryId(String value)	The memory ID from a previous response, used to continue a conversation with prior context.
final AgenticQuery.Builder	queryFields(String value, String... values)	A list of index fields that the agent should consider when generating the search query.
final AgenticQuery.Builder	queryFields(List<String> list)	A list of index fields that the agent should consider when generating the search query.
final AgenticQuery.Builder	queryText(String value)	Required - The natural language question to be answered by the agent.
protected AgenticQuery.Builder	self()

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

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public AgenticQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<AgenticQuery.Builder,AgenticQuery>

Returns:

a new builder instance.

self

@Nonnull
protected AgenticQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<AgenticQuery.Builder>

memoryId

@Nonnull
public final AgenticQuery.Builder memoryId(@Nullable
 String value)

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 AgenticQuery.Builder queryFields(List<String> list)

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

API name: query_fields

Adds all elements of list to queryFields.

queryFields

@Nonnull
public final AgenticQuery.Builder queryFields(String value,
 String... values)

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

API name: query_fields

Adds one or more values to queryFields.

queryText

@Nonnull
public final AgenticQuery.Builder queryText(String value)

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

API name: query_text

build

@Nonnull
public AgenticQuery build()

Builds a AgenticQuery.

Specified by:

build in interface ObjectBuilder<AgenticQuery>

Throws:

NullPointerException - if some of the required fields are null.