Spring AI

https://docs.spring.io/spring-ai/docs/2.0.0/
Admin
Spring AI provides an API specification for integrating various AI models and services into Spring...
Tokens:1,679,262
Snippets:22,877
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /v1/voices/settings/default

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/elevenlabs/api/ElevenLabsVoicesApi.html

Gets the default settings for voices.

```APIDOC
## GET /v1/voices/settings/default

### Description
Gets the default settings for voices.

### Method
GET

### Endpoint
/v1/voices/settings/default

### Response
#### Success Response (200)
- **stability** (Float) - Stability setting.
- **similarity_boost** (Float) - Similarity boost setting.
- **style** (Float) - Style setting.
- **use_speaker_boost** (Boolean) - Whether speaker boost is used.

#### Response Example
{
  "stability": 0.5,
  "similarity_boost": 0.5,
  "style": 0.5,
  "use_speaker_boost": true
}
```

--------------------------------

### setupAsyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer. Parameter semantics are the same as the sync client setup method.

```APIDOC
## setupAsyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)

### Description
Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer. See `setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)` for parameter semantics.

### Method
Static method

### Signature
`public static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)`

### Parameters
- `baseUrl` (String) - Optional - The base URL for the API (null to use default or environment variable)
- `apiKey` (String) - Optional - The API key (null to detect from environment)
- `timeout` (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- `maxRetries` (Integer) - Optional - The maximum number of retries (null to use default of 2)
- `proxy` (Proxy) - Optional - The proxy to use (null for no proxy)
- `customHeaders` (Map<String,String>) - Optional - Additional HTTP headers to include in requests
- `observationRegistry` (ObservationRegistry) - Required - The registry the OkHttp observation interceptor reports to; pass `ObservationRegistry.NOOP` to disable
- `meterRegistry` (MeterRegistry) - Optional - When supplied, OkHttp connection-pool gauges are registered

### Returns
A configured async Anthropic client
```

--------------------------------

### get(String key)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/model/AbstractResponseMetadata.html

Gets an entry from the context. Returns null when entry is not present.

```APIDOC
## get(String key)

### Description
Gets an entry from the context. Returns `null` when entry is not present.

### Method
`public <T> @Nullable T get(String key)`

### Parameters
- **key** (String) - Required - The key of the metadata entry.

### Returns
- The entry value, or `null` if not present.

### Type Parameters
- `T` - value type
```

--------------------------------

### OpenAiSetup.setupSyncClient

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/setup/OpenAiSetup.html

Static method to set up a synchronous OpenAI client with configurable authentication and connection settings.

```APIDOC
## OpenAiSetup.setupSyncClient

### Description
Sets up a synchronous OpenAI client. When `apiKey` is an empty string, the client is configured in no-auth mode: no `Authorization` header is sent with any request. This is useful for connecting to custom OpenAI-compatible servers that use cookie-based or other non-bearer-token authentication.

### Method
Static method

### Signature
`public static com.openai.client.OpenAIClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable com.openai.credential.Credential credential, @Nullable String azureDeploymentName, @Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAiServiceVersion, @Nullable String organizationId, boolean isAzure, boolean isGitHubModels, @Nullable String modelName, Duration timeout, int maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, List<OpenAiHttpClientBuilderCustomizer> httpClientCustomizers)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the OpenAI-compatible server.
- **apiKey** (String) - Optional - API key for authentication. If empty, no-auth mode is enabled.
- **credential** (com.openai.credential.Credential) - Optional - Credential for authentication.
- **azureDeploymentName** (String) - Optional - Azure deployment name.
- **azureOpenAiServiceVersion** (com.openai.azure.AzureOpenAIServiceVersion) - Optional - Azure OpenAI service version.
- **organizationId** (String) - Optional - Organization ID.
- **isAzure** (boolean) - Required - Whether the client is for Azure.
- **isGitHubModels** (boolean) - Required - Whether the client is for GitHub Models.
- **modelName** (String) - Optional - Model name.
- **timeout** (Duration) - Required - Timeout duration.
- **maxRetries** (int) - Required - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers.
- **observationRegistry** (io.micrometer.observation.ObservationRegistry) - Required - Observation registry.
- **meterRegistry** (io.micrometer.core.instrument.MeterRegistry) - Optional - Meter registry.
- **httpClientCustomizers** (List<OpenAiHttpClientBuilderCustomizer>) - Required - HTTP client customizers.

### Returns
- **com.openai.client.OpenAIClient** - The configured synchronous OpenAI client.

### Usage Notes
To enable no-auth mode, set `spring.ai.openai.api-key=` (empty value) in your application properties, or pass a `NoopApiKey` via `AbstractOpenAiOptions.AbstractBuilder.apiKey(org.springframework.ai.model.ApiKey)`.
```

--------------------------------

### Filter Expression Examples

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/vectorstore/filter/Filter.html

Examples of constructing filter expressions using the Filter class.

```APIDOC
## Filter Expression Examples

### Description
These examples demonstrate how to create portable metadata filter expressions using the Filter class. Each expression is built using the Expression constructor with operators (EQ, NE, LT, LTE, GT, GTE, IN, NIN, AND, OR) and operands (Key, Value, Group).

### Usage

#### Example 1: country == "BG"
```java
new Expression(EQ, new Key("country"), new Value("BG"));
```

#### Example 2: genre == "drama" AND year >= 2020
```java
new Expression(AND, new Expression(EQ, new Key("genre"), new Value("drama")),
    new Expression(GTE, new Key("year"), new Value(2020)));
```

#### Example 3: genre in ["comedy", "documentary", "drama"]
```java
new Expression(IN, new Key("genre"), new Value(List.of("comedy", "documentary", "drama")));
```

#### Example 4: year >= 2020 OR country == "BG" AND city != "Sofia"
```java
new Expression(OR, new Expression(GTE, new Key("year"), new Value(2020)),
    new Expression(AND, new Expression(EQ, new Key("country"), new Value("BG")),
        new Expression(NE, new Key("city"), new Value("Sofia"))));
```

#### Example 5: (year >= 2020 OR country == "BG") AND city NIN ["Sofia", "Plovdiv"]
```java
new Expression(AND,
    new Group(new Expression(OR, new Expression(EQ, new Key("country"), new Value("BG")),
        new Expression(GTE, new Key("year"), new Value(2020)))),
    new Expression(NIN, new Key("city"), new Value(List.of("Sofia", "Varna"))));
```

#### Example 6: isOpen == true AND year >= 2020 AND country IN ["BG", "NL", "US"]
```java
new Expression(AND, new Expression(EQ, new Key("isOpen"), new Value(true)),
    new Expression(AND, new Expression(GTE, new Key("year"), new Value(2020)),
        new Expression(IN, new Key("country"), new Value(List.of("BG", "NL", "US")))));
```

### Notes
- Operators: EQ, NE, LT, LTE, GT, GTE, IN, NIN, AND, OR
- Operands: Key (field name), Value (constant or list), Group (for grouping expressions)
- Expressions can be nested to compose complex filters.
```

--------------------------------

### OpenAiSetup.setupAsyncClient

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/setup/OpenAiSetup.html

Static method to set up an asynchronous OpenAI client with configurable authentication and connection settings.

```APIDOC
## OpenAiSetup.setupAsyncClient

### Description
Sets up an asynchronous OpenAI client. This method allows configuration of the client for various platforms including Azure and GitHub Models.

### Method
Static method

### Signature
`public static com.openai.client.OpenAIClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable com.openai.credential.Credential credential, @Nullable String azureDeploymentName, @Nullable com.openai.azure.AzureOpenAIServiceVersion azureOpenAiServiceVersion, @Nullable String organizationId, boolean isAzure, boolean isGitHubModels, @Nullable String modelName, Duration timeout, int maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, List<OpenAiHttpClientBuilderCustomizer> httpClientCustomizers)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the OpenAI-compatible server.
- **apiKey** (String) - Optional - API key for authentication.
- **credential** (com.openai.credential.Credential) - Optional - Credential for authentication.
- **azureDeploymentName** (String) - Optional - Azure deployment name.
- **azureOpenAiServiceVersion** (com.openai.azure.AzureOpenAIServiceVersion) - Optional - Azure OpenAI service version.
- **organizationId** (String) - Optional - Organization ID.
- **isAzure** (boolean) - Required - Whether the client is for Azure.
- **isGitHubModels** (boolean) - Required - Whether the client is for GitHub Models.
- **modelName** (String) - Optional - Model name.
- **timeout** (Duration) - Required - Timeout duration.
- **maxRetries** (int) - Required - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers.
- **observationRegistry** (io.micrometer.observation.ObservationRegistry) - Required - Observation registry.
- **meterRegistry** (io.micrometer.core.instrument.MeterRegistry) - Optional - Meter registry.
- **httpClientCustomizers** (List<OpenAiHttpClientBuilderCustomizer>) - Required - HTTP client customizers.

### Returns
- **com.openai.client.OpenAIClientAsync** - The configured asynchronous OpenAI client.
```

--------------------------------

### setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer.

```APIDOC
## setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry)

### Description
Creates an asynchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.

### Returns
- **com.anthropic.client.AnthropicClientAsync** - The configured asynchronous Anthropic client with Micrometer instrumentation.
```

--------------------------------

### Range query examples

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/vectorstore/redis/RedisVectorStore.html

Range query examples: search for similar documents within a similarity radius, optionally with a filter expression.

```java
 // Search for similar documents within a radius
 List<Document> results = vectorStore.searchByRange("AI technology", 0.8);

 // Search with radius and filter
 List<Document> filteredResults = vectorStore.searchByRange(
     "AI technology", 0.8, "category == 'research'"
 );
```

--------------------------------

### setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor, httpClientCustomizers)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

```APIDOC
## setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor, httpClientCustomizers)

### Description
Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor, List<AnthropicHttpClientBuilderCustomizer> httpClientCustomizers)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.
- **dispatcherExecutor** (ExecutorService) - Optional - Executor service for the dispatcher.
- **httpClientCustomizers** (List<AnthropicHttpClientBuilderCustomizer>) - Required - List of HTTP client customizers.

### Returns
- **com.anthropic.client.AnthropicClientAsync** - The configured asynchronous Anthropic client with customizers.
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/reader/jsoup/JsoupDocumentReader.html

Reads the HTML document and returns a list of Document objects containing the extracted text content. This method implements the Supplier interface's get method.

```APIDOC
## Method: get()

### Description
Reads the HTML document and returns a list of Document objects containing the extracted text content.

### Returns
- **List<Document>** - A list of Document objects with the extracted content.

### Example
```java
JsoupDocumentReader reader = new JsoupDocumentReader("<html>...</html>");
List<Document> documents = reader.get();
```
```

--------------------------------

### setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor, httpClientCustomizers)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

```APIDOC
## setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor, httpClientCustomizers)

### Description
Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor, List<AnthropicHttpClientBuilderCustomizer> httpClientCustomizers)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.
- **dispatcherExecutor** (ExecutorService) - Optional - Executor service for the dispatcher.
- **httpClientCustomizers** (List<AnthropicHttpClientBuilderCustomizer>) - Required - List of HTTP client customizers.

### Returns
- **com.anthropic.client.AnthropicClient** - The configured synchronous Anthropic client with customizers.
```

--------------------------------

### FilterExpressionBuilder common examples

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/vectorstore/filter/FilterExpressionBuilder.html

Common usage examples for the FilterExpressionBuilder DSL, covering eq, and, gte, in, or, ne, group, and nin operations. Each expression builds a Filter.Expression instance.

```java
var b = new FilterExpressionBuilder();

 // 1: country == "BG"
 var exp1 = b.eq("country", "BG");

 // 2: genre == "drama" AND year >= 2020
 var exp2 = b.and(b.eq("genre", "drama"), b.gte("year", 2020));

 // 3: genre in ["comedy", "documentary", "drama"]
 var exp3 = b.in("genre", "comedy", "documentary", "drama");

 // 4: year >= 2020 OR country == "BG" AND city != "Sofia"
 var exp4 = b.and(b.or(b.gte("year", 2020), b.eq("country", "BG")), b.ne("city", "Sofia"));

 // 5: (year >= 2020 OR country == "BG") AND city NIN ["Sofia", "Plovdiv"]
 var exp5 = b.and(b.group(b.or(b.gte("year", 2020), b.eq("country", "BG"))), b.nin("city", "Sofia", "Plovdiv"));

 // 6: isOpen == true AND year >= 2020 AND country IN ["BG", "NL", "US"]
 var exp6 = b.and(b.and(b.eq("isOpen", true), b.gte("year", 2020)), b.in("country", "BG", "NL", "US"));
```

--------------------------------

### Count query examples

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/vectorstore/redis/RedisVectorStore.html

Count query examples: count all documents, count with raw Redis query string, count with filter expression, and count with complex filter using Filter.builder().

```java
 // Count all documents
 long totalDocuments = vectorStore.count();

 // Count with raw Redis query string
 long aiDocuments = vectorStore.count("@category:{AI}");

 // Count with filter expression
 Filter.Expression yearFilter = new Filter.Expression(
     Filter.ExpressionType.EQ,
     new Filter.Key("year"),
     new Filter.Value(2023)
 );
 long docs2023 = vectorStore.count(yearFilter);

 // Count with complex filter
 long aiDocsFrom2023 = vectorStore.count(
     Filter.builder().eq("category", "AI").and().eq("year", 2023).build()
 );
```

--------------------------------

### setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor.

```APIDOC
## setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor)

### Description
Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.
- **dispatcherExecutor** (ExecutorService) - Optional - Executor service for the dispatcher.

### Returns
- **com.anthropic.client.AnthropicClientAsync** - The configured asynchronous Anthropic client with the supplied dispatcher executor.
```

--------------------------------

### getStreamOptions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiChatOptions.html

Gets the stream options.

```APIDOC
## getStreamOptions()

### Description
Gets the stream options.

### Method
GET

### Endpoint
N/A (SDK method)

### Parameters
None

### Returns
- **streamOptions** (OpenAiChatOptions.StreamOptions) - The stream options, or null if not set.

```

--------------------------------

### SystemPromptTemplate build()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/chat/prompt/SystemPromptTemplate.Builder.html

Builds the SystemPromptTemplate instance.

```APIDOC
## SystemPromptTemplate build()

### Description
Builds the SystemPromptTemplate instance with the configured settings. This method overrides the `build` method in `PromptTemplate.Builder`.

### Method
`public SystemPromptTemplate build()`

### Parameters
None

### Returns
A `SystemPromptTemplate` instance.

### Example
```java
SystemPromptTemplate prompt = new SystemPromptTemplate.Builder()
    .template("You are a helpful assistant.")
    .build();
```
```

--------------------------------

### getRegion()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/bedrock/api/AbstractBedrockApi.html

Gets the AWS region.

```APIDOC
## Method: getRegion

### Description
Get the AWS region.

### Returns
- **Region** - The AWS region.
```

--------------------------------

### setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client with the specified configuration.

```APIDOC
## setupAsyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders)

### Description
Creates an asynchronous Anthropic client with the specified configuration.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.

### Returns
- **com.anthropic.client.AnthropicClientAsync** - The configured asynchronous Anthropic client.
```

--------------------------------

### getModelId()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/bedrock/api/AbstractBedrockApi.html

Gets the model id.

```APIDOC
## Method: getModelId

### Description
Get the model id.

### Returns
- **String** - The model id.
```

--------------------------------

### setupSyncClient(String, String, Duration, Integer, Proxy, Map)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client with the specified configuration, delegating to the overload with observation registry and meter registry using no-op observation registry and no meter registry.

```APIDOC
## setupSyncClient(String, String, Duration, Integer, Proxy, Map)

### Description
Creates a synchronous Anthropic client with the specified configuration. Delegates to `setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)` with a `no-op` observation registry and no meter registry — i.e. HTTP-layer observability is disabled.

### Method
Static factory method

### Signature
`public static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders)`

### Parameters
- **baseUrl** (String) - Optional - The base URL for the API (null to use default or environment variable)
- **apiKey** (String) - Optional - The API key (null to detect from environment)
- **timeout** (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- **maxRetries** (Integer) - Optional - The maximum number of retries (null to use default of 2)
- **proxy** (Proxy) - Optional - The proxy to use (null for no proxy)
- **customHeaders** (Map<String,String>) - Optional - Additional HTTP headers to include in requests

### Returns
A configured Anthropic client
```

--------------------------------

### setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers. See `setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService)` for the remaining parameter semantics.

```APIDOC
## setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService, List<AnthropicHttpClientBuilderCustomizer>)

### Description
Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor and with optional HTTP client customizers. See `setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService)` for the remaining parameter semantics.

### Method
Static factory method

### Signature
`public static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor, List<AnthropicHttpClientBuilderCustomizer> httpClientCustomizers)`

### Parameters
- **baseUrl** (String) - Optional - The base URL for the API (null to use default or environment variable)
- **apiKey** (String) - Optional - The API key (null to detect from environment)
- **timeout** (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- **maxRetries** (Integer) - Optional - The maximum number of retries (null to use default of 2)
- **proxy** (Proxy) - Optional - The proxy to use (null for no proxy)
- **customHeaders** (Map<String,String>) - Optional - Additional HTTP headers to include in requests
- **observationRegistry** (ObservationRegistry) - Required - The registry the OkHttp observation interceptor reports to; pass `ObservationRegistry.NOOP` to disable
- **meterRegistry** (MeterRegistry) - Optional - When supplied, OkHttp connection-pool gauges (active/idle connections) are registered
- **dispatcherExecutor** (ExecutorService) - Optional - The OkHttp dispatcher executor; null to use the library-managed default
- **httpClientCustomizers** (List<AnthropicHttpClientBuilderCustomizer>) - Required - Customizers applied to the underlying OkHttp client builder after Spring AI's own defaults; useful for registering interceptors (e.g. OAuth2 bearer-token injection) or custom TLS configuration

### Returns
A configured Anthropic client
```

--------------------------------

### getRegions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/reader/pdf/layout/PDFLayoutTextStripperByArea.html

Gets the list of regions that have been set up.

```APIDOC
## [METHOD] getRegions

### Description
Gets the list of regions that have been set up.

### Method
List<String>

### Signature
`List<String> getRegions()`

### Parameters
None

### Returns
List<String> - The list of region names.
```

--------------------------------

### getStore()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiChatOptions.html

Gets whether to store the conversation.

```APIDOC
## getStore()

### Description
Gets whether to store the conversation.

### Method
GET

### Endpoint
N/A (SDK method)

### Parameters
None

### Returns
- **store** (Boolean) - true if the conversation should be stored, or null if not set.

```

--------------------------------

### build()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/vectorstore/qdrant/QdrantVectorStore.Builder.html

Builds and returns a new QdrantVectorStore instance with the configured settings.

```APIDOC
## build()

### Description
Builds and returns a new QdrantVectorStore instance with the configured settings.

### Method
build

### Signature
public QdrantVectorStore build()

### Returns
a new QdrantVectorStore instance

### Throws
- `IllegalStateException` - if the builder configuration is invalid
```

--------------------------------

### getLogitBias()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiChatOptions.html

Gets the logit bias map.

```APIDOC
## getLogitBias()

### Description
Gets the logit bias map.

### Method
GET

### Endpoint
N/A (SDK method)

### Parameters
None

### Returns
- **logitBias** (Map<String,Integer>) - The logit bias map, or null if not set.

```

--------------------------------

### setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client with the specified configuration.

```APIDOC
## setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders)

### Description
Creates a synchronous Anthropic client with the specified configuration.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.

### Returns
- **com.anthropic.client.AnthropicClient** - The configured synchronous Anthropic client.
```

--------------------------------

### setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric + `traceparent` propagation), and, when a `MeterRegistry` is supplied, OkHttp connection-pool gauges are bound to it.

```APIDOC
## setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)

### Description
Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric + `traceparent` propagation), and, when a `MeterRegistry` is supplied, OkHttp connection-pool gauges are bound to it.

### Method
Static factory method

### Signature
`public static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)`

### Parameters
- **baseUrl** (String) - Optional - The base URL for the API (null to use default or environment variable)
- **apiKey** (String) - Optional - The API key (null to detect from environment)
- **timeout** (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- **maxRetries** (Integer) - Optional - The maximum number of retries (null to use default of 2)
- **proxy** (Proxy) - Optional - The proxy to use (null for no proxy)
- **customHeaders** (Map<String,String>) - Optional - Additional HTTP headers to include in requests
- **observationRegistry** (ObservationRegistry) - Required - The registry the OkHttp observation interceptor reports to; pass `ObservationRegistry.NOOP` to disable
- **meterRegistry** (MeterRegistry) - Optional - When supplied, OkHttp connection-pool gauges (active/idle connections) are registered

### Returns
A configured Anthropic client

### Since
2.0.0
```

--------------------------------

### getOptions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiImageModel.html

Gets the image options for this model.

```APIDOC
## getOptions()

### Description
Gets the image options for this model.

### Method
getOptions

### Signature
`OpenAiImageOptions getOptions()`

### Returns
- **OpenAiImageOptions** - The image options configured for this model.

```

--------------------------------

### setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric + `traceparent` propagation), and, when a `MeterRegistry` is supplied, OkHttp connection-pool gauges are bound to it.

```APIDOC
## setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry)

### Description
Creates a synchronous Anthropic client whose underlying OkHttp client is instrumented with Micrometer: each HTTP attempt emits an observation (span + metric + `traceparent` propagation), and, when a `MeterRegistry` is supplied, OkHttp connection-pool gauges are bound to it.

### Method
static

### Signature
`static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.

### Returns
- **com.anthropic.client.AnthropicClient** - The configured synchronous Anthropic client with Micrometer instrumentation.
```

--------------------------------

### OpenAiChatOptions.getStreamOptions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/class-use/OpenAiChatOptions.StreamOptions.html

Gets the stream options from OpenAiChatOptions.

```APIDOC
## OpenAiChatOptions.getStreamOptions()

### Description
Gets the stream options from OpenAiChatOptions.

### Method
`@Nullable OpenAiChatOptions.StreamOptions getStreamOptions()`

### Return Type
`@Nullable OpenAiChatOptions.StreamOptions`
```

--------------------------------

### setupAsyncClient(String, String, Duration, Integer, Proxy, Map)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client with the specified configuration, delegating to the overload with observation registry and meter registry using a no-op observation registry and no meter registry, disabling HTTP-layer observability.

```APIDOC
## setupAsyncClient(String, String, Duration, Integer, Proxy, Map)

### Description
Creates an asynchronous Anthropic client with the specified configuration. Delegates to `setupAsyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry)` with a `no-op` observation registry and no meter registry — i.e. HTTP-layer observability is disabled.

### Method
Static method

### Signature
`public static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders)`

### Parameters
- `baseUrl` (String) - Optional - The base URL for the API (null to use default or environment variable)
- `apiKey` (String) - Optional - The API key (null to detect from environment)
- `timeout` (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- `maxRetries` (Integer) - Optional - The maximum number of retries (null to use default of 2)
- `proxy` (Proxy) - Optional - The proxy to use (null for no proxy)
- `customHeaders` (Map<String,String>) - Optional - Additional HTTP headers to include in requests

### Returns
A configured async Anthropic client
```

--------------------------------

### OpenAiEmbeddingModel.getOptions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiEmbeddingModel.html

Gets the embedding options for this model.

```APIDOC
## OpenAiEmbeddingModel.getOptions()

### Description
Gets the embedding options for this model.

### Method
OpenAiEmbeddingOptions

### Endpoint
OpenAiEmbeddingModel.getOptions()

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **OpenAiEmbeddingOptions** - The embedding options.

#### Response Example
```java
OpenAiEmbeddingOptions options = model.getOptions();
```
```

--------------------------------

### OpenAiChatOptions.getResponseFormat()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/class-use/OpenAiChatModel.ResponseFormat.html

Gets the response format configuration.

```APIDOC
## OpenAiChatOptions.getResponseFormat()

### Description
Gets the response format configuration.

### Method
`@Nullable OpenAiChatModel.ResponseFormat getResponseFormat()`

### Returns
- **OpenAiChatModel.ResponseFormat** - The response format configuration, or null if not set.
```

--------------------------------

### setupAsyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor. The caller owns the executor's lifecycle; closing the resulting client will not shut it down.

```APIDOC
## setupAsyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService)

### Description
Creates an asynchronous Anthropic client backed by a caller-supplied dispatcher executor. The caller owns the executor's lifecycle; closing the resulting client will not shut it down. See `setupSyncClient(String, String, Duration, Integer, Proxy, Map, ObservationRegistry, MeterRegistry, ExecutorService)` for the dispatcher executor's role.

### Method
Static method

### Signature
`public static com.anthropic.client.AnthropicClientAsync setupAsyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor)`

### Parameters
- `baseUrl` (String) - Optional - The base URL for the API (null to use default or environment variable)
- `apiKey` (String) - Optional - The API key (null to detect from environment)
- `timeout` (Duration) - Optional - The request timeout (null to use default of 60 seconds)
- `maxRetries` (Integer) - Optional - The maximum number of retries (null to use default of 2)
- `proxy` (Proxy) - Optional - The proxy to use (null for no proxy)
- `customHeaders` (Map<String,String>) - Optional - Additional HTTP headers to include in requests
- `observationRegistry` (ObservationRegistry) - Required - The registry the OkHttp observation interceptor reports to; pass `ObservationRegistry.NOOP` to disable
- `meterRegistry` (MeterRegistry) - Optional - When supplied, OkHttp connection-pool gauges are registered
- `dispatcherExecutor` (ExecutorService) - Optional - The OkHttp dispatcher executor; null to use the library-managed default

### Returns
A configured async Anthropic client
```

--------------------------------

### getOptions()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/openai/OpenAiAudioTranscriptionModel.html

Gets the transcription options for this model.

```APIDOC
## getOptions()

### Description
Gets the transcription options for this model.

### Method
getOptions

### Signature
`public OpenAiAudioTranscriptionOptions getOptions()`

### Returns
The transcription options.
```

--------------------------------

### setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor)

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/anthropic/AnthropicSetup.html

Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor (e.g. one built around `Executors.newVirtualThreadPerTaskExecutor()` on Java 21+).

```APIDOC
## setupSyncClient(baseUrl, apiKey, timeout, maxRetries, proxy, customHeaders, observationRegistry, meterRegistry, dispatcherExecutor)

### Description
Creates a synchronous Anthropic client backed by a caller-supplied dispatcher executor (e.g. one built around `Executors.newVirtualThreadPerTaskExecutor()` on Java 21+).

### Method
static

### Signature
`static com.anthropic.client.AnthropicClient setupSyncClient(@Nullable String baseUrl, @Nullable String apiKey, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable io.micrometer.core.instrument.MeterRegistry meterRegistry, @Nullable ExecutorService dispatcherExecutor)`

### Parameters
- **baseUrl** (String) - Optional - Base URL for the Anthropic API.
- **apiKey** (String) - Optional - API key for authentication.
- **timeout** (Duration) - Optional - Timeout duration for requests.
- **maxRetries** (Integer) - Optional - Maximum number of retries.
- **proxy** (Proxy) - Optional - Proxy configuration.
- **customHeaders** (Map<String,String>) - Optional - Custom headers to include in requests.
- **observationRegistry** (ObservationRegistry) - Required - Observation registry for Micrometer instrumentation.
- **meterRegistry** (MeterRegistry) - Optional - Meter registry for Micrometer metrics.
- **dispatcherExecutor** (ExecutorService) - Optional - Executor service for the dispatcher.

### Returns
- **com.anthropic.client.AnthropicClient** - The configured synchronous Anthropic client with the supplied dispatcher executor.
```

--------------------------------

### MediaContent.getMedia()

Source: https://docs.spring.io/spring-ai/docs/2.0.0/api/org/springframework/ai/content/class-use/Media.html

Get the media associated with the content.

```APIDOC
## MediaContent.getMedia()

### Description
Get the media associated with the content.

### Method
getMedia

### Returns
- **List<Media>** - The list of media associated with the content.
```
Tokens:
Raw