Package co.elastic.clients.elasticsearch.inference

Class AlibabaCloudServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<AlibabaCloudServiceSettings.Builder>

co.elastic.clients.elasticsearch.inference.AlibabaCloudServiceSettings.Builder

All Implemented Interfaces:

WithJson<AlibabaCloudServiceSettings.Builder>, ObjectBuilder<AlibabaCloudServiceSettings>

Enclosing class:

AlibabaCloudServiceSettings

public static class AlibabaCloudServiceSettings.Builder
extends WithJsonObjectBuilderBase<AlibabaCloudServiceSettings.Builder>
implements ObjectBuilder<AlibabaCloudServiceSettings>

Builder for AlibabaCloudServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AlibabaCloudServiceSettings.Builder	apiKey(String value)	Required - A valid API key for the AlibabaCloud AI Search API.
AlibabaCloudServiceSettings	build()	Builds a AlibabaCloudServiceSettings.
final AlibabaCloudServiceSettings.Builder	host(String value)	Required - The name of the host address used for the inference task.
final AlibabaCloudServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.
final AlibabaCloudServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search.
protected AlibabaCloudServiceSettings.Builder	self()
final AlibabaCloudServiceSettings.Builder	serviceId(String value)	Required - The name of the model service to use for the inference task.
final AlibabaCloudServiceSettings.Builder	workspace(String value)	Required - The name of the workspace used for the inference task.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

apiKey

public final AlibabaCloudServiceSettings.Builder apiKey(String value)

Required - A valid API key for the AlibabaCloud AI Search API.

API name: api_key

host

public final AlibabaCloudServiceSettings.Builder host(String value)

Required - The name of the host address used for the inference task. You can find the host address in the API keys section of the documentation.

API name: host

rateLimit

public final AlibabaCloudServiceSettings.Builder rateLimit(@Nullable
 RateLimitSetting value)

This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search. By default, the alibabacloud-ai-search service sets the number of requests allowed per minute to 1000.

API name: rate_limit

rateLimit

public final AlibabaCloudServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)

This setting helps to minimize the number of rate limit errors returned from AlibabaCloud AI Search. By default, the alibabacloud-ai-search service sets the number of requests allowed per minute to 1000.

API name: rate_limit

serviceId

public final AlibabaCloudServiceSettings.Builder serviceId(String value)

Required - The name of the model service to use for the inference task. The following service IDs are available for the completion task:

• ops-qwen-turbo
• qwen-turbo
• qwen-plus
• qwen-max ÷ qwen-max-longcontext

The following service ID is available for the rerank task:

• ops-bge-reranker-larger

The following service ID is available for the sparse_embedding task:

• ops-text-sparse-embedding-001

The following service IDs are available for the text_embedding task:

ops-text-embedding-001 ops-text-embedding-zh-001 ops-text-embedding-en-001 ops-text-embedding-002

API name: service_id

workspace

public final AlibabaCloudServiceSettings.Builder workspace(String value)

Required - The name of the workspace used for the inference task.

API name: workspace

self

protected AlibabaCloudServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AlibabaCloudServiceSettings.Builder>

build

public AlibabaCloudServiceSettings build()

Builds a AlibabaCloudServiceSettings.

Specified by:

build in interface ObjectBuilder<AlibabaCloudServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.