Package org.springframework.ai.openai.api

Enum Class OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize

java.lang.Object

java.lang.Enum<OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize>

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize

All Implemented Interfaces:

Serializable, Comparable<OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize>, Constable

Enclosing class:

OpenAiApi.ChatCompletionRequest.WebSearchOptions

public static enum OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize
extends Enum<OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize>

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH	High context size.
LOW	Low context size.
MEDIUM	Medium context size.

Method Summary

Modifier and Type	Method	Description
static OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOW

public static final OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize LOW

Low context size.

MEDIUM

public static final OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize MEDIUM

Medium context size. This is the default.

HIGH

public static final OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize HIGH

High context size.

Method Details

values

public static OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OpenAiApi.ChatCompletionRequest.WebSearchOptions.SearchContextSize valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null