Package com.azure.search.documents.agents

Class SearchKnowledgeAgentClientBuilder

java.lang.Object

com.azure.search.documents.agents.SearchKnowledgeAgentClientBuilder

All Implemented Interfaces:

com.azure.core.client.traits.AzureKeyCredentialTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.EndpointTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SearchKnowledgeAgentClientBuilder>

public final class SearchKnowledgeAgentClientBuilder
extends Object
implements com.azure.core.client.traits.AzureKeyCredentialTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.EndpointTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SearchKnowledgeAgentClientBuilder>

This class provides a fluent builder API to help configure and instantiate SearchKnowledgeAgentClient and SearchKnowledgeAgentAsyncClient for interacting with Azure AI Search Knowledge Agents.

Overview

This builder enables the creation of both synchronous and asynchronous clients for Azure AI Search Knowledge Agents, allowing you to interact with knowledge retrieval and agent-based search capabilities. The builder supports configuration of authentication, endpoint, agent name, API version, and HTTP pipeline options, following Azure SDK for Java standards.

Getting Started

To create a client, configure the required properties such as the service endpoint, agent name, API version, and authentication credentials. The builder supports both API key and Microsoft Entra ID (role-based) authentication. Additional options such as custom HTTP pipeline policies, retry options, logging, and serialization can also be configured.

Authentication

Azure AI Search Knowledge Agents support authentication using either an AzureKeyCredential (API key) or a TokenCredential (Microsoft Entra ID). When using Microsoft Entra ID, you may also specify a SearchAudience to target a specific Azure cloud environment.

Client Instantiation

Use buildClient() to create a synchronous SearchKnowledgeAgentClient, or buildAsyncClient() to create an asynchronous SearchKnowledgeAgentAsyncClient. Each call to these methods returns a new client instance with the configured options.

Thread Safety

Client instances created by this builder are thread-safe and intended to be shared and reused across threads. The builder itself is not thread-safe and should not be used concurrently from multiple threads.

Additional Information

• For more information about Azure AI Search Knowledge Agents, see the Azure documentation.
• For authentication details, see the Azure AI Search security documentation.
• For Azure SDK for Java guidelines, see the Azure SDK for Java Introduction.

See Also:

• SearchKnowledgeAgentClient
• SearchKnowledgeAgentAsyncClient
• com.azure.search.documents.agents

Constructor Summary

Constructors

Constructor	Description
SearchKnowledgeAgentClientBuilder()	Creates a new builder instance.

Method Summary

Modifier and Type	Method	Description
SearchKnowledgeAgentClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
SearchKnowledgeAgentClientBuilder	agentName(String agentName)	Sets the agent name for the Azure AI Search agent.
SearchKnowledgeAgentClientBuilder	audience(SearchAudience audience)	Sets the audience for the Azure AI Search instance.
SearchKnowledgeAgentAsyncClient	buildAsyncClient()	Builds an asynchronous SearchKnowledgeAgentAsyncClient.
SearchKnowledgeAgentClient	buildClient()	Builds a synchronous SearchKnowledgeAgentClient.
SearchKnowledgeAgentClientBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions)
SearchKnowledgeAgentClientBuilder	configuration(com.azure.core.util.Configuration configuration)
SearchKnowledgeAgentClientBuilder	credential(com.azure.core.credential.AzureKeyCredential credential)
SearchKnowledgeAgentClientBuilder	credential(com.azure.core.credential.TokenCredential credential)
SearchKnowledgeAgentClientBuilder	endpoint(String endpoint)	Sets the service endpoint for the Azure AI Search instance.
SearchKnowledgeAgentClientBuilder	httpClient(com.azure.core.http.HttpClient client)
SearchKnowledgeAgentClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
SearchKnowledgeAgentClientBuilder	pipeline(com.azure.core.http.HttpPipeline httpPipeline)
SearchKnowledgeAgentClientBuilder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
SearchKnowledgeAgentClientBuilder	serviceVersion(SearchServiceVersion apiVersion)	Sets the API version to use for requests.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchKnowledgeAgentClientBuilder

public SearchKnowledgeAgentClientBuilder()

Creates a new builder instance.

Method Details

endpoint

public SearchKnowledgeAgentClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure AI Search instance.

Specified by:

endpoint in interface com.azure.core.client.traits.EndpointTrait<SearchKnowledgeAgentClientBuilder>

Parameters:

endpoint - The URL of the Azure AI Search instance.

Returns:

The updated builder object.

agentName

public SearchKnowledgeAgentClientBuilder agentName(String agentName)

Sets the agent name for the Azure AI Search agent.

Parameters:

agentName - The name of the agent.

Returns:

The updated builder object.

serviceVersion

public SearchKnowledgeAgentClientBuilder serviceVersion(SearchServiceVersion apiVersion)

Sets the API version to use for requests.

Parameters:

apiVersion - The API version.

Returns:

The updated builder object.

credential

public SearchKnowledgeAgentClientBuilder credential(com.azure.core.credential.AzureKeyCredential credential)

Specified by:

credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<SearchKnowledgeAgentClientBuilder>

credential

public SearchKnowledgeAgentClientBuilder credential(com.azure.core.credential.TokenCredential credential)

Specified by:

credential in interface com.azure.core.client.traits.TokenCredentialTrait<SearchKnowledgeAgentClientBuilder>

audience

public SearchKnowledgeAgentClientBuilder audience(SearchAudience audience)

Sets the audience for the Azure AI Search instance.

Parameters:

audience - The audience to use.

Returns:

The updated builder object.

httpLogOptions

public SearchKnowledgeAgentClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Specified by:

httpLogOptions in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

clientOptions

public SearchKnowledgeAgentClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Specified by:

clientOptions in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

addPolicy

public SearchKnowledgeAgentClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Specified by:

addPolicy in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

httpClient

public SearchKnowledgeAgentClientBuilder httpClient(com.azure.core.http.HttpClient client)

Specified by:

httpClient in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

pipeline

public SearchKnowledgeAgentClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)

Specified by:

pipeline in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

configuration

public SearchKnowledgeAgentClientBuilder configuration(com.azure.core.util.Configuration configuration)

Specified by:

configuration in interface com.azure.core.client.traits.ConfigurationTrait<SearchKnowledgeAgentClientBuilder>

retryOptions

public SearchKnowledgeAgentClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)

Specified by:

retryOptions in interface com.azure.core.client.traits.HttpTrait<SearchKnowledgeAgentClientBuilder>

buildClient

public SearchKnowledgeAgentClient buildClient()

Builds a synchronous SearchKnowledgeAgentClient.

Returns:

a new SearchKnowledgeAgentClient instance.

buildAsyncClient

public SearchKnowledgeAgentAsyncClient buildAsyncClient()

Builds an asynchronous SearchKnowledgeAgentAsyncClient.

Returns:

a new SearchKnowledgeAgentAsyncClient instance.