S-index

A B C D E F G H I J K L M N O P Q R S T U V W X Y _

S

SAGE - enum entry in com.openai.models.audio.speech.SpeechCreateParams.Voice.Known

SAGE - enum entry in com.openai.models.audio.speech.SpeechCreateParams.Voice.Value

SAGE - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Voice.Known

SAGE - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Voice.Value

sample() - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileContent.Content

sample(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileContent.Content.Builder

Sets Builder.sample to an arbitrary JSON value.

sample(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileContent.Content.Sample) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileContent.Content.Builder

sample() - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileContent.Content

sample(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileContent.Content.Builder

Sets Builder.sample to an arbitrary JSON value.

sample(com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileContent.Content.Sample) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileContent.Content.Builder

sample() - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse

A sample containing the input and output of the evaluation run.

sample(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Builder

Sets Builder.sample to an arbitrary JSON value.

sample(com.openai.models.evals.runs.outputitems.OutputItemListResponse.Sample) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Builder

A sample containing the input and output of the evaluation run.

sample() - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse

A sample containing the input and output of the evaluation run.

sample(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Builder

Sets Builder.sample to an arbitrary JSON value.

sample(com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Sample) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Builder

A sample containing the input and output of the evaluation run.

samplingParams() - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource

samplingParams(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Sets Builder.samplingParams to an arbitrary JSON value.

samplingParams(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.SamplingParams) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

SCALE - enum entry in com.openai.models.chat.completions.ChatCompletion.ServiceTier.Known

SCALE - enum entry in com.openai.models.chat.completions.ChatCompletion.ServiceTier.Value

SCALE - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.ServiceTier.Known

SCALE - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.ServiceTier.Value

schema() - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema

The schema for the response format, described as a JSON Schema object.

schema(com.openai.core.JsonField) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

Sets Builder.schema to an arbitrary JSON value.

schema(com.openai.models.ResponseFormatJsonSchema.JsonSchema.Schema) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

The schema for the response format, described as a JSON Schema object.

schema() - function in com.openai.models.evals.EvalCustomDataSourceConfig

The json schema for the run data source items.

schema(com.openai.core.JsonField) - function in com.openai.models.evals.EvalCustomDataSourceConfig.Builder

Sets Builder.schema to an arbitrary JSON value.

schema(com.openai.models.evals.EvalCustomDataSourceConfig.Schema) - function in com.openai.models.evals.EvalCustomDataSourceConfig.Builder

The json schema for the run data source items.

schema() - function in com.openai.models.evals.EvalStoredCompletionsDataSourceConfig

The json schema for the run data source items.

schema(com.openai.core.JsonField) - function in com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Builder

Sets Builder.schema to an arbitrary JSON value.

schema(com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Schema) - function in com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Builder

The json schema for the run data source items.

schema() - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig

The schema for the response format, described as a JSON Schema object.

schema(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

Sets Builder.schema to an arbitrary JSON value.

schema(com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Schema) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

The schema for the response format, described as a JSON Schema object.

score() - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result

The score of the result.

score(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Builder

Sets Builder.score to an arbitrary JSON value.

score(java.lang.Double) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Builder

The score of the result.

score() - function in com.openai.models.responses.ResponseFileSearchToolCall.Result

The relevance score of the file - a value between 0 and 1.

score(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFileSearchToolCall.Result.Builder

Sets Builder.score to an arbitrary JSON value.

score(java.lang.Double) - function in com.openai.models.responses.ResponseFileSearchToolCall.Result.Builder

The relevance score of the file - a value between 0 and 1.

score() - function in com.openai.models.vectorstores.VectorStoreSearchResponse

The similarity score for the result.

score(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreSearchResponse.Builder

Sets Builder.score to an arbitrary JSON value.

score(java.lang.Double) - function in com.openai.models.vectorstores.VectorStoreSearchResponse.Builder

The similarity score for the result.

scoreThreshold() - function in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions

The score threshold for the file search.

scoreThreshold(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions.Builder

Sets Builder.scoreThreshold to an arbitrary JSON value.

scoreThreshold(java.lang.Double) - function in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions.Builder

The score threshold for the file search.

scoreThreshold() - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions

The score threshold for the file search.

scoreThreshold(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions.Builder

Sets Builder.scoreThreshold to an arbitrary JSON value.

scoreThreshold(java.lang.Double) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions.Builder

The score threshold for the file search.

scoreThreshold() - function in com.openai.models.responses.FileSearchTool.RankingOptions

The score threshold for the file search, a number between 0 and 1.

scoreThreshold(com.openai.core.JsonField) - function in com.openai.models.responses.FileSearchTool.RankingOptions.Builder

Sets Builder.scoreThreshold to an arbitrary JSON value.

scoreThreshold(java.lang.Double) - function in com.openai.models.responses.FileSearchTool.RankingOptions.Builder

The score threshold for the file search, a number between 0 and 1.

scoreThreshold() - function in com.openai.models.vectorstores.VectorStoreSearchParams.RankingOptions

scoreThreshold(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreSearchParams.RankingOptions.Builder

Sets Builder.scoreThreshold to an arbitrary JSON value.

scoreThreshold(java.lang.Double) - function in com.openai.models.vectorstores.VectorStoreSearchParams.RankingOptions.Builder

screenshot() - function in com.openai.models.responses.ResponseComputerToolCall.Action

A screenshot action.

scroll() - function in com.openai.models.responses.ResponseComputerToolCall.Action

A scroll action.

scrollX() - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll

The horizontal scroll distance.

scrollX(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll.Builder

Sets Builder.scrollX to an arbitrary JSON value.

scrollX(java.lang.Long) - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll.Builder

The horizontal scroll distance.

scrollY() - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll

The vertical scroll distance.

scrollY(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll.Builder

Sets Builder.scrollY to an arbitrary JSON value.

scrollY(java.lang.Long) - function in com.openai.models.responses.ResponseComputerToolCall.Action.Scroll.Builder

The vertical scroll distance.

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.async.VectorStoreServiceAsync

Search a vector store for relevant chunks based on a query and file attributes filter.

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.async.VectorStoreServiceAsync

Search a vector store for relevant chunks based on a query and file attributes filter.

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.async.VectorStoreServiceAsync

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.async.VectorStoreServiceAsync.WithRawResponse

Returns a raw HTTP response for post /vector_stores/{vector_store_id}/search, but is otherwise the same as VectorStoreServiceAsync.search.

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.async.VectorStoreServiceAsync.WithRawResponse

Returns a raw HTTP response for post /vector_stores/{vector_store_id}/search, but is otherwise the same as VectorStoreServiceAsync.search.

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.async.VectorStoreServiceAsync.WithRawResponse

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.async.VectorStoreServiceAsyncImpl

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.async.VectorStoreServiceAsyncImpl.WithRawResponseImpl

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.blocking.VectorStoreService

Search a vector store for relevant chunks based on a query and file attributes filter.

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.blocking.VectorStoreService

Search a vector store for relevant chunks based on a query and file attributes filter.

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.VectorStoreService

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.blocking.VectorStoreService.WithRawResponse

Returns a raw HTTP response for post /vector_stores/{vector_store_id}/search, but is otherwise the same as VectorStoreService.search.

search(com.openai.models.vectorstores.VectorStoreSearchParams) - function in com.openai.services.blocking.VectorStoreService.WithRawResponse

Returns a raw HTTP response for post /vector_stores/{vector_store_id}/search, but is otherwise the same as VectorStoreService.search.

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.VectorStoreService.WithRawResponse

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.VectorStoreServiceImpl

search(com.openai.models.vectorstores.VectorStoreSearchParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.VectorStoreServiceImpl.WithRawResponseImpl

searchContextSize() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.WebSearchOptions

High level guidance for the amount of context window space to use for the search.

searchContextSize(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.WebSearchOptions.Builder

Sets Builder.searchContextSize to an arbitrary JSON value.

searchContextSize(com.openai.models.chat.completions.ChatCompletionCreateParams.WebSearchOptions.SearchContextSize) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.WebSearchOptions.Builder

High level guidance for the amount of context window space to use for the search.

searchContextSize() - function in com.openai.models.responses.WebSearchTool

High level guidance for the amount of context window space to use for the search.

searchContextSize(com.openai.core.JsonField) - function in com.openai.models.responses.WebSearchTool.Builder

Sets Builder.searchContextSize to an arbitrary JSON value.

searchContextSize(com.openai.models.responses.WebSearchTool.SearchContextSize) - function in com.openai.models.responses.WebSearchTool.Builder

High level guidance for the amount of context window space to use for the search.

SEARCHING - enum entry in com.openai.models.responses.ResponseFileSearchToolCall.Status.Known

SEARCHING - enum entry in com.openai.models.responses.ResponseFileSearchToolCall.Status.Value

SEARCHING - enum entry in com.openai.models.responses.ResponseFunctionWebSearch.Status.Known

SEARCHING - enum entry in com.openai.models.responses.ResponseFunctionWebSearch.Status.Value

seed() - function in com.openai.models.chat.completions.ChatCompletionCreateParams

This feature is in Beta.

seed() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body

This feature is in Beta.

seed(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

This feature is in Beta.

seed(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

This feature is in Beta.

seed() - function in com.openai.models.completions.CompletionCreateParams

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

seed() - function in com.openai.models.completions.CompletionCreateParams.Body

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

seed(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

seed(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.completions.CompletionCreateParams.Builder

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

seed() - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.SamplingParams

A seed value to initialize the randomness, during sampling.

seed(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.SamplingParams.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.lang.Long) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.SamplingParams.Builder

A seed value to initialize the randomness, during sampling.

seed() - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Sample

The seed used for generating the sample.

seed(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Sample.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.lang.Long) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Sample.Builder

The seed used for generating the sample.

seed() - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Sample

The seed used for generating the sample.

seed(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Sample.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.lang.Long) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Sample.Builder

The seed used for generating the sample.

seed() - function in com.openai.models.finetuning.jobs.FineTuningJob

The seed used for the fine-tuning job.

seed(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.lang.Long) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

The seed used for the fine-tuning job.

seed() - function in com.openai.models.finetuning.jobs.JobCreateParams

The seed controls the reproducibility of the job.

seed() - function in com.openai.models.finetuning.jobs.JobCreateParams.Body

The seed controls the reproducibility of the job.

seed(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

The seed controls the reproducibility of the job.

seed(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

Sets Builder.seed to an arbitrary JSON value.

seed(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

Alias for calling Builder.seed with seed.orElse(null).

seed(java.lang.Long) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

Alias for Builder.seed.

seed(java.lang.Long) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

The seed controls the reproducibility of the job.

seek() - function in com.openai.models.audio.transcriptions.TranscriptionSegment

Seek offset of the segment.

seek(com.openai.core.JsonField) - function in com.openai.models.audio.transcriptions.TranscriptionSegment.Builder

Sets Builder.seek to an arbitrary JSON value.

seek(java.lang.Long) - function in com.openai.models.audio.transcriptions.TranscriptionSegment.Builder

Seek offset of the segment.

SEGMENT - enum entry in com.openai.models.audio.transcriptions.TranscriptionCreateParams.TimestampGranularity.Known

SEGMENT - enum entry in com.openai.models.audio.transcriptions.TranscriptionCreateParams.TimestampGranularity.Value

segments() - function in com.openai.models.audio.transcriptions.TranscriptionVerbose

Segments of the transcribed text and their corresponding details.

segments(com.openai.core.JsonField) - function in com.openai.models.audio.transcriptions.TranscriptionVerbose.Builder

Sets Builder.segments to an arbitrary JSON value.

segments(java.util.List) - function in com.openai.models.audio.transcriptions.TranscriptionVerbose.Builder

Segments of the transcribed text and their corresponding details.

segments() - function in com.openai.models.audio.translations.TranslationVerbose

Segments of the translated text and their corresponding details.

segments(com.openai.core.JsonField) - function in com.openai.models.audio.translations.TranslationVerbose.Builder

Sets Builder.segments to an arbitrary JSON value.

segments(java.util.List) - function in com.openai.models.audio.translations.TranslationVerbose.Builder

Segments of the translated text and their corresponding details.

selfHarm() - function in com.openai.models.moderations.Moderation.Categories

Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.

selfHarm(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sets Builder.selfHarm to an arbitrary JSON value.

selfHarm(java.lang.Boolean) - function in com.openai.models.moderations.Moderation.Categories.Builder

Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders.

selfHarm() - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes

The applied input type(s) for the category 'self-harm'.

selfHarm(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

Sets Builder.selfHarm to an arbitrary JSON value.

selfHarm(java.util.List) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

The applied input type(s) for the category 'self-harm'.

selfHarm() - function in com.openai.models.moderations.Moderation.CategoryScores

The score for the category 'self-harm'.

selfHarm(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

Sets Builder.selfHarm to an arbitrary JSON value.

selfHarm(java.lang.Double) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

The score for the category 'self-harm'.

selfHarmInstructions() - function in com.openai.models.moderations.Moderation.Categories

Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.

selfHarmInstructions(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sets Builder.selfHarmInstructions to an arbitrary JSON value.

selfHarmInstructions(java.lang.Boolean) - function in com.openai.models.moderations.Moderation.Categories.Builder

Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts.

selfHarmInstructions() - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes

The applied input type(s) for the category 'self-harm/instructions'.

selfHarmInstructions(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

Sets Builder.selfHarmInstructions to an arbitrary JSON value.

selfHarmInstructions(java.util.List) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

The applied input type(s) for the category 'self-harm/instructions'.

selfHarmInstructions() - function in com.openai.models.moderations.Moderation.CategoryScores

The score for the category 'self-harm/instructions'.

selfHarmInstructions(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

Sets Builder.selfHarmInstructions to an arbitrary JSON value.

selfHarmInstructions(java.lang.Double) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

The score for the category 'self-harm/instructions'.

selfHarmIntent() - function in com.openai.models.moderations.Moderation.Categories

Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.

selfHarmIntent(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sets Builder.selfHarmIntent to an arbitrary JSON value.

selfHarmIntent(java.lang.Boolean) - function in com.openai.models.moderations.Moderation.Categories.Builder

Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders.

selfHarmIntent() - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes

The applied input type(s) for the category 'self-harm/intent'.

selfHarmIntent(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

Sets Builder.selfHarmIntent to an arbitrary JSON value.

selfHarmIntent(java.util.List) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

The applied input type(s) for the category 'self-harm/intent'.

selfHarmIntent() - function in com.openai.models.moderations.Moderation.CategoryScores

The score for the category 'self-harm/intent'.

selfHarmIntent(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

Sets Builder.selfHarmIntent to an arbitrary JSON value.

selfHarmIntent(java.lang.Double) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

The score for the category 'self-harm/intent'.

serialize(T,com.fasterxml.jackson.core.JsonGenerator,com.fasterxml.jackson.databind.SerializerProvider) - function in com.fasterxml.jackson.databind.ser.std.StdSerializer

serialize(com.openai.core.JsonMissing,com.fasterxml.jackson.core.JsonGenerator,com.fasterxml.jackson.databind.SerializerProvider) - function in com.openai.core.JsonMissing.Serializer

serializeWithType(T,com.fasterxml.jackson.core.JsonGenerator,com.fasterxml.jackson.databind.SerializerProvider,com.fasterxml.jackson.databind.jsontype.TypeSerializer) - function in com.fasterxml.jackson.databind.JsonSerializer

serializeWithType(com.openai.core.JsonMissing,com.fasterxml.jackson.core.JsonGenerator,com.fasterxml.jackson.databind.SerializerProvider,com.fasterxml.jackson.databind.jsontype.TypeSerializer) - function in com.fasterxml.jackson.databind.JsonSerializer

SERVER_ERROR - enum entry in com.openai.models.beta.threads.runs.Run.LastError.Code.Known

SERVER_ERROR - enum entry in com.openai.models.beta.threads.runs.Run.LastError.Code.Value

SERVER_ERROR - enum entry in com.openai.models.beta.threads.runs.steps.RunStep.LastError.Code.Known

SERVER_ERROR - enum entry in com.openai.models.beta.threads.runs.steps.RunStep.LastError.Code.Value

SERVER_ERROR - enum entry in com.openai.models.responses.ResponseError.Code.Known

SERVER_ERROR - enum entry in com.openai.models.responses.ResponseError.Code.Value

SERVER_ERROR - enum entry in com.openai.models.vectorstores.files.VectorStoreFile.LastError.Code.Known

SERVER_ERROR - enum entry in com.openai.models.vectorstores.files.VectorStoreFile.LastError.Code.Value

serviceTier() - function in com.openai.models.chat.completions.ChatCompletion

The service tier used for processing the request.

serviceTier(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletion.Builder

Sets Builder.serviceTier to an arbitrary JSON value.

serviceTier(com.openai.models.chat.completions.ChatCompletion.ServiceTier) - function in com.openai.models.chat.completions.ChatCompletion.Builder

The service tier used for processing the request.

serviceTier(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletion.Builder

Alias for calling Builder.serviceTier with serviceTier.orElse(null).

serviceTier() - function in com.openai.models.chat.completions.ChatCompletionChunk

The service tier used for processing the request.

serviceTier(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionChunk.Builder

Sets Builder.serviceTier to an arbitrary JSON value.

serviceTier(com.openai.models.chat.completions.ChatCompletionChunk.ServiceTier) - function in com.openai.models.chat.completions.ChatCompletionChunk.Builder

The service tier used for processing the request.

serviceTier(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionChunk.Builder

Alias for calling Builder.serviceTier with serviceTier.orElse(null).

serviceTier() - function in com.openai.models.chat.completions.ChatCompletionCreateParams

Specifies the latency tier to use for processing the request.

serviceTier() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body

Specifies the latency tier to use for processing the request.

serviceTier(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Sets Builder.serviceTier to an arbitrary JSON value.

serviceTier(com.openai.models.chat.completions.ChatCompletionCreateParams.ServiceTier) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Specifies the latency tier to use for processing the request.

serviceTier(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling Builder.serviceTier with serviceTier.orElse(null).

serviceTier(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Sets Builder.serviceTier to an arbitrary JSON value.

serviceTier(com.openai.models.chat.completions.ChatCompletionCreateParams.ServiceTier) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Specifies the latency tier to use for processing the request.

serviceTier(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling Builder.serviceTier with serviceTier.orElse(null).

setStackTrace(kotlin.Array) - function in kotlin.Throwable

sexual() - function in com.openai.models.moderations.Moderation.Categories

Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).

sexual(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sets Builder.sexual to an arbitrary JSON value.

sexual(java.lang.Boolean) - function in com.openai.models.moderations.Moderation.Categories.Builder

Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness).

sexual() - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes

The applied input type(s) for the category 'sexual'.

sexual(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

Sets Builder.sexual to an arbitrary JSON value.

sexual(java.util.List) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

The applied input type(s) for the category 'sexual'.

sexual() - function in com.openai.models.moderations.Moderation.CategoryScores

The score for the category 'sexual'.

sexual(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

Sets Builder.sexual to an arbitrary JSON value.

sexual(java.lang.Double) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

The score for the category 'sexual'.

sexualMinors() - function in com.openai.models.moderations.Moderation.Categories

Sexual content that includes an individual who is under 18 years old.

sexualMinors(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sets Builder.sexualMinors to an arbitrary JSON value.

sexualMinors(java.lang.Boolean) - function in com.openai.models.moderations.Moderation.Categories.Builder

Sexual content that includes an individual who is under 18 years old.

sexualMinors() - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes

The applied input type(s) for the category 'sexual/minors'.

sexualMinors(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

Sets Builder.sexualMinors to an arbitrary JSON value.

sexualMinors(java.util.List) - function in com.openai.models.moderations.Moderation.CategoryAppliedInputTypes.Builder

The applied input type(s) for the category 'sexual/minors'.

sexualMinors() - function in com.openai.models.moderations.Moderation.CategoryScores

The score for the category 'sexual/minors'.

sexualMinors(com.openai.core.JsonField) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

Sets Builder.sexualMinors to an arbitrary JSON value.

sexualMinors(java.lang.Double) - function in com.openai.models.moderations.Moderation.CategoryScores.Builder

The score for the category 'sexual/minors'.

shareWithOpenAI() - function in com.openai.models.evals.EvalCreateParams

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI() - function in com.openai.models.evals.EvalCreateParams.Body

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalCreateParams.Body.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalCreateParams.Body.Builder

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalCreateParams.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalCreateParams.Builder

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI() - function in com.openai.models.evals.EvalCreateResponse

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalCreateResponse.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalCreateResponse.Builder

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI() - function in com.openai.models.evals.EvalListResponse

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalListResponse.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalListResponse.Builder

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI() - function in com.openai.models.evals.EvalRetrieveResponse

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalRetrieveResponse.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalRetrieveResponse.Builder

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI() - function in com.openai.models.evals.EvalUpdateResponse

Indicates whether the evaluation is shared with OpenAI.

shareWithOpenAI(com.openai.core.JsonField) - function in com.openai.models.evals.EvalUpdateResponse.Builder

Sets Builder.shareWithOpenAI to an arbitrary JSON value.

shareWithOpenAI(java.lang.Boolean) - function in com.openai.models.evals.EvalUpdateResponse.Builder

Indicates whether the evaluation is shared with OpenAI.

SHIMMER - enum entry in com.openai.models.audio.speech.SpeechCreateParams.Voice.Known

SHIMMER - enum entry in com.openai.models.audio.speech.SpeechCreateParams.Voice.Value

SHIMMER - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Voice.Known

SHIMMER - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Voice.Value

simpleInputMessage() - function in com.openai.models.evals.EvalCreateParams.TestingCriterion.LabelModel.Input

size() - function in com.openai.core.http.Headers

size() - function in com.openai.core.http.QueryParams

size() - function in com.openai.models.images.ImageCreateVariationParams

The size of the generated images.

size() - function in com.openai.models.images.ImageCreateVariationParams.Body

The size of the generated images.

size(com.openai.core.MultipartField) - function in com.openai.models.images.ImageCreateVariationParams.Body.Builder

Sets Builder.size to an arbitrary multipart value.

size(com.openai.models.images.ImageCreateVariationParams.Size) - function in com.openai.models.images.ImageCreateVariationParams.Body.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageCreateVariationParams.Body.Builder

Alias for calling Builder.size with size.orElse(null).

size(com.openai.core.MultipartField) - function in com.openai.models.images.ImageCreateVariationParams.Builder

Sets Builder.size to an arbitrary multipart value.

size(com.openai.models.images.ImageCreateVariationParams.Size) - function in com.openai.models.images.ImageCreateVariationParams.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageCreateVariationParams.Builder

Alias for calling Builder.size with size.orElse(null).

size() - function in com.openai.models.images.ImageEditParams

The size of the generated images.

size() - function in com.openai.models.images.ImageEditParams.Body

The size of the generated images.

size(com.openai.core.MultipartField) - function in com.openai.models.images.ImageEditParams.Body.Builder

Sets Builder.size to an arbitrary multipart value.

size(com.openai.models.images.ImageEditParams.Size) - function in com.openai.models.images.ImageEditParams.Body.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageEditParams.Body.Builder

Alias for calling Builder.size with size.orElse(null).

size(com.openai.core.MultipartField) - function in com.openai.models.images.ImageEditParams.Builder

Sets Builder.size to an arbitrary multipart value.

size(com.openai.models.images.ImageEditParams.Size) - function in com.openai.models.images.ImageEditParams.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageEditParams.Builder

Alias for calling Builder.size with size.orElse(null).

size() - function in com.openai.models.images.ImageGenerateParams

The size of the generated images.

size() - function in com.openai.models.images.ImageGenerateParams.Body

The size of the generated images.

size(com.openai.core.JsonField) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

Sets Builder.size to an arbitrary JSON value.

size(com.openai.models.images.ImageGenerateParams.Size) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

Alias for calling Builder.size with size.orElse(null).

size(com.openai.core.JsonField) - function in com.openai.models.images.ImageGenerateParams.Builder

Sets Builder.size to an arbitrary JSON value.

size(com.openai.models.images.ImageGenerateParams.Size) - function in com.openai.models.images.ImageGenerateParams.Builder

The size of the generated images.

size(java.util.Optional) - function in com.openai.models.images.ImageGenerateParams.Builder

Alias for calling Builder.size with size.orElse(null).

source() - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource

A StoredCompletionsRunDataSource configuration describing a set of filters

source(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Sets Builder.source to an arbitrary JSON value.

source(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

A StoredCompletionsRunDataSource configuration describing a set of filters

source(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileContent) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Alias for calling source with Source.ofFileContent(fileContent).

source(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.FileId) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Alias for calling source with Source.ofFileId(fileId).

source(com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source.StoredCompletions) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Alias for calling source with Source.ofStoredCompletions(storedCompletions).

source() - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource

source(com.openai.core.JsonField) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

Sets Builder.source to an arbitrary JSON value.

source(com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

source(com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileContent) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

Alias for calling source with Source.ofFileContent(fileContent).

source(com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Source.FileId) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

Alias for calling source with Source.ofFileId(fileId).

speech() - function in com.openai.services.async.AudioServiceAsync

speech() - function in com.openai.services.async.AudioServiceAsync.WithRawResponse

speech() - function in com.openai.services.async.AudioServiceAsyncImpl

speech() - function in com.openai.services.async.AudioServiceAsyncImpl.WithRawResponseImpl

speech() - function in com.openai.services.blocking.AudioService

speech() - function in com.openai.services.blocking.AudioService.WithRawResponse

speech() - function in com.openai.services.blocking.AudioServiceImpl

speech() - function in com.openai.services.blocking.AudioServiceImpl.WithRawResponseImpl

SpeechCreateParams - class in com.openai.models.audio.speech

Generates audio from the input text.

SpeechCreateParams.Body - class in com.openai.models.audio.speech.SpeechCreateParams

SpeechCreateParams.Body.Builder - class in com.openai.models.audio.speech.SpeechCreateParams.Body

A builder for Body.

SpeechCreateParams.Builder - class in com.openai.models.audio.speech.SpeechCreateParams

A builder for SpeechCreateParams.

SpeechCreateParams.ResponseFormat - class in com.openai.models.audio.speech.SpeechCreateParams

The format to audio in.

SpeechCreateParams.ResponseFormat.Known - class in com.openai.models.audio.speech.SpeechCreateParams.ResponseFormat

An enum containing ResponseFormat's known values.

SpeechCreateParams.ResponseFormat.Value - class in com.openai.models.audio.speech.SpeechCreateParams.ResponseFormat

An enum containing ResponseFormat's known values, as well as an _UNKNOWN member.

SpeechCreateParams.Voice - class in com.openai.models.audio.speech.SpeechCreateParams

The voice to use when generating the audio.

SpeechCreateParams.Voice.Known - class in com.openai.models.audio.speech.SpeechCreateParams.Voice

An enum containing Voice's known values.

SpeechCreateParams.Voice.Value - class in com.openai.models.audio.speech.SpeechCreateParams.Voice

An enum containing Voice's known values, as well as an _UNKNOWN member.

SpeechModel - class in com.openai.models.audio.speech

SpeechModel.Known - class in com.openai.models.audio.speech.SpeechModel

An enum containing SpeechModel's known values.

SpeechModel.Value - class in com.openai.models.audio.speech.SpeechModel

An enum containing SpeechModel's known values, as well as an _UNKNOWN member.

SpeechService - class in com.openai.services.blocking.audio

SpeechService.WithRawResponse - class in com.openai.services.blocking.audio.SpeechService

A view of SpeechService that provides access to raw HTTP responses for each method.

SpeechServiceAsync - class in com.openai.services.async.audio

SpeechServiceAsync.WithRawResponse - class in com.openai.services.async.audio.SpeechServiceAsync

A view of SpeechServiceAsync that provides access to raw HTTP responses for each method.

SpeechServiceAsyncImpl - class in com.openai.services.async.audio

SpeechServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.audio.SpeechServiceAsyncImpl

SpeechServiceImpl - class in com.openai.services.blocking.audio

SpeechServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.audio.SpeechServiceImpl

speed() - function in com.openai.models.audio.speech.SpeechCreateParams

The speed of the generated audio.

speed() - function in com.openai.models.audio.speech.SpeechCreateParams.Body

The speed of the generated audio.

speed(com.openai.core.JsonField) - function in com.openai.models.audio.speech.SpeechCreateParams.Body.Builder

Sets Builder.speed to an arbitrary JSON value.

speed(java.lang.Double) - function in com.openai.models.audio.speech.SpeechCreateParams.Body.Builder

The speed of the generated audio.

speed(com.openai.core.JsonField) - function in com.openai.models.audio.speech.SpeechCreateParams.Builder

Sets Builder.speed to an arbitrary JSON value.

speed(java.lang.Double) - function in com.openai.models.audio.speech.SpeechCreateParams.Builder

The speed of the generated audio.

spliterator() - function in kotlin.collections.Iterable

SRT - enum entry in com.openai.models.audio.AudioResponseFormat.Known

SRT - enum entry in com.openai.models.audio.AudioResponseFormat.Value

SRT - enum entry in com.openai.models.audio.translations.TranslationCreateParams.ResponseFormat.Known

SRT - enum entry in com.openai.models.audio.translations.TranslationCreateParams.ResponseFormat.Value

SseException - class in com.openai.errors

SseException.Builder - class in com.openai.errors.SseException

A builder for SseException.

STANDARD - enum entry in com.openai.models.images.ImageGenerateParams.Quality.Known

STANDARD - enum entry in com.openai.models.images.ImageGenerateParams.Quality.Value

start() - function in com.openai.models.audio.transcriptions.TranscriptionSegment

Start time of the segment in seconds.

start(com.openai.core.JsonField) - function in com.openai.models.audio.transcriptions.TranscriptionSegment.Builder

Sets Builder.start to an arbitrary JSON value.

start(java.lang.Double) - function in com.openai.models.audio.transcriptions.TranscriptionSegment.Builder

Start time of the segment in seconds.

start() - function in com.openai.models.audio.transcriptions.TranscriptionWord

Start time of the word in seconds.

start(com.openai.core.JsonField) - function in com.openai.models.audio.transcriptions.TranscriptionWord.Builder

Sets Builder.start to an arbitrary JSON value.

start(java.lang.Double) - function in com.openai.models.audio.transcriptions.TranscriptionWord.Builder

Start time of the word in seconds.

startedAt() - function in com.openai.models.beta.threads.runs.Run

The Unix timestamp (in seconds) for when the run was started.

startedAt(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.Run.Builder

Sets Builder.startedAt to an arbitrary JSON value.

startedAt(java.util.Optional) - function in com.openai.models.beta.threads.runs.Run.Builder

Alias for calling Builder.startedAt with startedAt.orElse(null).

startedAt(java.lang.Long) - function in com.openai.models.beta.threads.runs.Run.Builder

Alias for Builder.startedAt.

startedAt(java.lang.Long) - function in com.openai.models.beta.threads.runs.Run.Builder

The Unix timestamp (in seconds) for when the run was started.

startIndex() - function in com.openai.models.beta.threads.messages.FileCitationAnnotation

startIndex(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.FileCitationAnnotation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.beta.threads.messages.FileCitationAnnotation.Builder

startIndex() - function in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation

startIndex(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.Builder

startIndex() - function in com.openai.models.beta.threads.messages.FilePathAnnotation

startIndex(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.FilePathAnnotation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.beta.threads.messages.FilePathAnnotation.Builder

startIndex() - function in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation

startIndex(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.Builder

startIndex() - function in com.openai.models.chat.completions.ChatCompletionMessage.Annotation.UrlCitation

The index of the first character of the URL citation in the message.

startIndex(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionMessage.Annotation.UrlCitation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.chat.completions.ChatCompletionMessage.Annotation.UrlCitation.Builder

The index of the first character of the URL citation in the message.

startIndex() - function in com.openai.models.responses.ResponseOutputText.Annotation.UrlCitation

The index of the first character of the URL citation in the message.

startIndex(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseOutputText.Annotation.UrlCitation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.responses.ResponseOutputText.Annotation.UrlCitation.Builder

The index of the first character of the URL citation in the message.

startIndex() - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.UrlCitation

The index of the first character of the URL citation in the message.

startIndex(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.UrlCitation.Builder

Sets Builder.startIndex to an arbitrary JSON value.

startIndex(java.lang.Long) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.UrlCitation.Builder

The index of the first character of the URL citation in the message.

static_() - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy

static_() - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject

static_(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

Sets Builder.static_ to an arbitrary JSON value.

static_(com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

static_() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy

static_() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject

static_(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

Sets Builder.static_ to an arbitrary JSON value.

static_(com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

static_() - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy

static_() - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject

static_(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

Sets Builder.static_ to an arbitrary JSON value.

static_(com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Builder

static_() - function in com.openai.models.vectorstores.FileChunkingStrategy

static_() - function in com.openai.models.vectorstores.FileChunkingStrategyParam

Customize your own chunking strategy by setting chunk size and chunk overlap.

static_() - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObject

static_(com.openai.core.JsonField) - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObject.Builder

Sets Builder.static_ to an arbitrary JSON value.

static_(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObject.Builder

static_() - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObjectParam

static_(com.openai.core.JsonField) - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObjectParam.Builder

Sets Builder.static_ to an arbitrary JSON value.

static_(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.StaticFileChunkingStrategyObjectParam.Builder

staticChunkingStrategy(com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.Builder

Alias for calling chunkingStrategy with the following:

ChunkingStrategy.StaticObject.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.Builder

Alias for calling chunkingStrategy with the following:

ChunkingStrategy.StaticObject.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.ChunkingStrategy.StaticObject.Static) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.Builder

Alias for calling chunkingStrategy with the following:

ChunkingStrategy.StaticObject.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Body.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Body.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.files.FileCreateParams.Body.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.files.FileCreateParams.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObjectParam.builder()
    .static_(static_)
    .build()

staticChunkingStrategy(com.openai.models.vectorstores.StaticFileChunkingStrategy) - function in com.openai.models.vectorstores.files.VectorStoreFile.Builder

Alias for calling chunkingStrategy with the following:

StaticFileChunkingStrategyObject.builder()
    .static_(static_)
    .build()

StaticFileChunkingStrategy - class in com.openai.models.vectorstores

StaticFileChunkingStrategy.Builder - class in com.openai.models.vectorstores.StaticFileChunkingStrategy

A builder for StaticFileChunkingStrategy.

StaticFileChunkingStrategyObject - class in com.openai.models.vectorstores

StaticFileChunkingStrategyObject.Builder - class in com.openai.models.vectorstores.StaticFileChunkingStrategyObject

A builder for StaticFileChunkingStrategyObject.

StaticFileChunkingStrategyObjectParam - class in com.openai.models.vectorstores

Customize your own chunking strategy by setting chunk size and chunk overlap.

StaticFileChunkingStrategyObjectParam.Builder - class in com.openai.models.vectorstores.StaticFileChunkingStrategyObjectParam

A builder for StaticFileChunkingStrategyObjectParam.

status() - function in com.openai.models.batches.Batch

The current status of the batch.

status(com.openai.core.JsonField) - function in com.openai.models.batches.Batch.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.batches.Batch.Status) - function in com.openai.models.batches.Batch.Builder

The current status of the batch.

status() - function in com.openai.models.beta.threads.messages.Message

The status of the message, which can be either in_progress, incomplete, or completed.

status(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.Message.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.beta.threads.messages.Message.Status) - function in com.openai.models.beta.threads.messages.Message.Builder

The status of the message, which can be either in_progress, incomplete, or completed.

status() - function in com.openai.models.beta.threads.runs.Run

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

status(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.Run.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.beta.threads.runs.RunStatus) - function in com.openai.models.beta.threads.runs.Run.Builder

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

status() - function in com.openai.models.beta.threads.runs.steps.RunStep

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

status(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.beta.threads.runs.steps.RunStep.Status) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.

status() - function in com.openai.models.evals.runs.RunCancelResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.RunCancelResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.RunCancelResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.evals.runs.RunCreateResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.RunCreateResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.RunCreateResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.evals.runs.RunListParams

Filter runs by status.

status(com.openai.models.evals.runs.RunListParams.Status) - function in com.openai.models.evals.runs.RunListParams.Builder

Filter runs by status.

status(java.util.Optional) - function in com.openai.models.evals.runs.RunListParams.Builder

Alias for calling Builder.status with status.orElse(null).

status() - function in com.openai.models.evals.runs.RunListResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.RunListResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.RunListResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.evals.runs.RunRetrieveResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.RunRetrieveResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.RunRetrieveResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.evals.runs.outputitems.OutputItemListParams

Filter output items by status.

status(com.openai.models.evals.runs.outputitems.OutputItemListParams.Status) - function in com.openai.models.evals.runs.outputitems.OutputItemListParams.Builder

Filter output items by status.

status(java.util.Optional) - function in com.openai.models.evals.runs.outputitems.OutputItemListParams.Builder

Alias for calling Builder.status with status.orElse(null).

status() - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.outputitems.OutputItemListResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse

The status of the evaluation run.

status(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Builder

Sets Builder.status to an arbitrary JSON value.

status(java.lang.String) - function in com.openai.models.evals.runs.outputitems.OutputItemRetrieveResponse.Builder

The status of the evaluation run.

status() - function in com.openai.models.files.FileObject

Deprecated.

status(com.openai.core.JsonField) - function in com.openai.models.files.FileObject.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.files.FileObject.Status) - function in com.openai.models.files.FileObject.Builder

Deprecated.

status() - function in com.openai.models.finetuning.jobs.FineTuningJob

The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.

status(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.finetuning.jobs.FineTuningJob.Status) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

The current status of the fine-tuning job, which can be either validating_files, queued, running, succeeded, failed, or cancelled.

status() - function in com.openai.models.responses.Response

The status of the response generation.

status(com.openai.core.JsonField) - function in com.openai.models.responses.Response.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseStatus) - function in com.openai.models.responses.Response.Builder

The status of the response generation.

status() - function in com.openai.models.responses.ResponseCodeInterpreterToolCall

The status of the code interpreter tool call.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseCodeInterpreterToolCall.Status) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Builder

The status of the code interpreter tool call.

status() - function in com.openai.models.responses.ResponseComputerToolCall

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseComputerToolCall.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseComputerToolCall.Status) - function in com.openai.models.responses.ResponseComputerToolCall.Builder

The status of the item.

status() - function in com.openai.models.responses.ResponseComputerToolCallOutputItem

The status of the message input.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseComputerToolCallOutputItem.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseComputerToolCallOutputItem.Status) - function in com.openai.models.responses.ResponseComputerToolCallOutputItem.Builder

The status of the message input.

status() - function in com.openai.models.responses.ResponseFileSearchToolCall

The status of the file search tool call.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFileSearchToolCall.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseFileSearchToolCall.Status) - function in com.openai.models.responses.ResponseFileSearchToolCall.Builder

The status of the file search tool call.

status() - function in com.openai.models.responses.ResponseFunctionToolCall

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFunctionToolCall.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseFunctionToolCall.Status) - function in com.openai.models.responses.ResponseFunctionToolCall.Builder

The status of the item.

status() - function in com.openai.models.responses.ResponseFunctionToolCallItem

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFunctionToolCallItem.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseFunctionToolCall.Status) - function in com.openai.models.responses.ResponseFunctionToolCallItem.Builder

The status of the item.

status() - function in com.openai.models.responses.ResponseFunctionToolCallOutputItem

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFunctionToolCallOutputItem.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseFunctionToolCallOutputItem.Status) - function in com.openai.models.responses.ResponseFunctionToolCallOutputItem.Builder

The status of the item.

status() - function in com.openai.models.responses.ResponseFunctionWebSearch

The status of the web search tool call.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFunctionWebSearch.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseFunctionWebSearch.Status) - function in com.openai.models.responses.ResponseFunctionWebSearch.Builder

The status of the web search tool call.

status() - function in com.openai.models.responses.ResponseInputItem.ComputerCallOutput

The status of the message input.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputItem.ComputerCallOutput.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseInputItem.ComputerCallOutput.Status) - function in com.openai.models.responses.ResponseInputItem.ComputerCallOutput.Builder

The status of the message input.

status() - function in com.openai.models.responses.ResponseInputItem.FunctionCallOutput

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputItem.FunctionCallOutput.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseInputItem.FunctionCallOutput.Status) - function in com.openai.models.responses.ResponseInputItem.FunctionCallOutput.Builder

The status of the item.

status() - function in com.openai.models.responses.ResponseInputItem.Message

The status of item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputItem.Message.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseInputItem.Message.Status) - function in com.openai.models.responses.ResponseInputItem.Message.Builder

The status of item.

status() - function in com.openai.models.responses.ResponseInputMessageItem

The status of item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputMessageItem.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseInputMessageItem.Status) - function in com.openai.models.responses.ResponseInputMessageItem.Builder

The status of item.

status() - function in com.openai.models.responses.ResponseOutputMessage

The status of the message input.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseOutputMessage.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseOutputMessage.Status) - function in com.openai.models.responses.ResponseOutputMessage.Builder

The status of the message input.

status() - function in com.openai.models.responses.ResponseReasoningItem

The status of the item.

status(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseReasoningItem.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.responses.ResponseReasoningItem.Status) - function in com.openai.models.responses.ResponseReasoningItem.Builder

The status of the item.

status() - function in com.openai.models.uploads.Upload

The status of the Upload.

status(com.openai.core.JsonField) - function in com.openai.models.uploads.Upload.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.uploads.Upload.Status) - function in com.openai.models.uploads.Upload.Builder

The status of the Upload.

status() - function in com.openai.models.vectorstores.VectorStore

The status of the vector store, which can be either expired, in_progress, or completed.

status(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStore.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.vectorstores.VectorStore.Status) - function in com.openai.models.vectorstores.VectorStore.Builder

The status of the vector store, which can be either expired, in_progress, or completed.

status() - function in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

status(com.openai.core.JsonField) - function in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Status) - function in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Builder

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

status() - function in com.openai.models.vectorstores.files.VectorStoreFile

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed.

status(com.openai.core.JsonField) - function in com.openai.models.vectorstores.files.VectorStoreFile.Builder

Sets Builder.status to an arbitrary JSON value.

status(com.openai.models.vectorstores.files.VectorStoreFile.Status) - function in com.openai.models.vectorstores.files.VectorStoreFile.Builder

The status of the vector store file, which can be either in_progress, completed, cancelled, or failed.

statusCode() - function in com.openai.core.http.HttpResponse

statusCode() - function in com.openai.core.http.HttpResponseFor

statusCode() - function in com.openai.errors.BadRequestException

statusCode() - function in com.openai.errors.InternalServerException

statusCode(java.lang.Integer) - function in com.openai.errors.InternalServerException.Builder

statusCode() - function in com.openai.errors.NotFoundException

statusCode() - function in com.openai.errors.OpenAIServiceException

statusCode() - function in com.openai.errors.PermissionDeniedException

statusCode() - function in com.openai.errors.RateLimitException

statusCode() - function in com.openai.errors.SseException

statusCode(java.lang.Integer) - function in com.openai.errors.SseException.Builder

statusCode() - function in com.openai.errors.UnauthorizedException

statusCode() - function in com.openai.errors.UnexpectedStatusCodeException

statusCode(java.lang.Integer) - function in com.openai.errors.UnexpectedStatusCodeException.Builder

statusCode() - function in com.openai.errors.UnprocessableEntityException

statusDetails() - function in com.openai.models.files.FileObject

Deprecated.

statusDetails(com.openai.core.JsonField) - function in com.openai.models.files.FileObject.Builder

Sets Builder.statusDetails to an arbitrary JSON value.

statusDetails(java.lang.String) - function in com.openai.models.files.FileObject.Builder

Deprecated.

step() - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Metrics

step(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Metrics.Builder

Sets Builder.step to an arbitrary JSON value.

step(java.lang.Double) - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Metrics.Builder

STEP_DETAILS_TOOL_CALLS_FILE_SEARCH_RESULTS_CONTENT - enum entry in com.openai.models.beta.threads.runs.steps.RunStepInclude.Known

STEP_DETAILS_TOOL_CALLS_FILE_SEARCH_RESULTS_CONTENT - enum entry in com.openai.models.beta.threads.runs.steps.RunStepInclude.Value

stepDetails() - function in com.openai.models.beta.threads.runs.steps.RunStep

The details of the run step.

stepDetails(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

Sets Builder.stepDetails to an arbitrary JSON value.

stepDetails(com.openai.models.beta.threads.runs.steps.MessageCreationStepDetails) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

Alias for calling stepDetails with StepDetails.ofMessageCreation(messageCreation).

stepDetails(com.openai.models.beta.threads.runs.steps.RunStep.StepDetails) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

The details of the run step.

stepDetails(com.openai.models.beta.threads.runs.steps.ToolCallsStepDetails) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

Alias for calling stepDetails with StepDetails.ofToolCalls(toolCalls).

stepDetails() - function in com.openai.models.beta.threads.runs.steps.RunStepDelta

The details of the run step.

stepDetails(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.RunStepDelta.Builder

Sets Builder.stepDetails to an arbitrary JSON value.

stepDetails(com.openai.models.beta.threads.runs.steps.RunStepDelta.StepDetails) - function in com.openai.models.beta.threads.runs.steps.RunStepDelta.Builder

The details of the run step.

stepDetails(com.openai.models.beta.threads.runs.steps.RunStepDeltaMessageDelta) - function in com.openai.models.beta.threads.runs.steps.RunStepDelta.Builder

Alias for calling stepDetails with StepDetails.ofMessageCreation(messageCreation).

stepDetails(com.openai.models.beta.threads.runs.steps.ToolCallDeltaObject) - function in com.openai.models.beta.threads.runs.steps.RunStepDelta.Builder

Alias for calling stepDetails with StepDetails.ofToolCalls(toolCalls).

stepId() - function in com.openai.models.beta.threads.runs.steps.StepRetrieveParams

stepId(java.lang.String) - function in com.openai.models.beta.threads.runs.steps.StepRetrieveParams.Builder

StepListPage - class in com.openai.models.beta.threads.runs.steps

Returns a list of run steps belonging to a run.

StepListPage.AutoPager - class in com.openai.models.beta.threads.runs.steps.StepListPage

StepListPage.Response - class in com.openai.models.beta.threads.runs.steps.StepListPage

StepListPage.Response.Builder - class in com.openai.models.beta.threads.runs.steps.StepListPage.Response

StepListPageAsync - class in com.openai.models.beta.threads.runs.steps

Returns a list of run steps belonging to a run.

StepListPageAsync.AutoPager - class in com.openai.models.beta.threads.runs.steps.StepListPageAsync

StepListPageAsync.Response - class in com.openai.models.beta.threads.runs.steps.StepListPageAsync

StepListPageAsync.Response.Builder - class in com.openai.models.beta.threads.runs.steps.StepListPageAsync.Response

StepListParams - class in com.openai.models.beta.threads.runs.steps

Returns a list of run steps belonging to a run.

StepListParams.Builder - class in com.openai.models.beta.threads.runs.steps.StepListParams

A builder for StepListParams.

StepListParams.Order - class in com.openai.models.beta.threads.runs.steps.StepListParams

Sort order by the created_at timestamp of the objects.

StepListParams.Order.Known - class in com.openai.models.beta.threads.runs.steps.StepListParams.Order

An enum containing Order's known values.

StepListParams.Order.Value - class in com.openai.models.beta.threads.runs.steps.StepListParams.Order

An enum containing Order's known values, as well as an _UNKNOWN member.

stepNumber() - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint

The step number that the checkpoint was created at.

stepNumber(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Builder

Sets Builder.stepNumber to an arbitrary JSON value.

stepNumber(java.lang.Long) - function in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Builder

The step number that the checkpoint was created at.

StepRetrieveParams - class in com.openai.models.beta.threads.runs.steps

Retrieves a run step.

StepRetrieveParams.Builder - class in com.openai.models.beta.threads.runs.steps.StepRetrieveParams

A builder for StepRetrieveParams.

steps() - function in com.openai.services.async.beta.threads.RunServiceAsync

steps() - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

steps() - function in com.openai.services.async.beta.threads.RunServiceAsyncImpl

steps() - function in com.openai.services.async.beta.threads.RunServiceAsyncImpl.WithRawResponseImpl

steps() - function in com.openai.services.blocking.beta.threads.RunService

steps() - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

steps() - function in com.openai.services.blocking.beta.threads.RunServiceImpl

steps() - function in com.openai.services.blocking.beta.threads.RunServiceImpl.WithRawResponseImpl

StepService - class in com.openai.services.blocking.beta.threads.runs

StepService.WithRawResponse - class in com.openai.services.blocking.beta.threads.runs.StepService

A view of StepService that provides access to raw HTTP responses for each method.

StepServiceAsync - class in com.openai.services.async.beta.threads.runs

StepServiceAsync.WithRawResponse - class in com.openai.services.async.beta.threads.runs.StepServiceAsync

A view of StepServiceAsync that provides access to raw HTTP responses for each method.

StepServiceAsyncImpl - class in com.openai.services.async.beta.threads.runs

StepServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.beta.threads.runs.StepServiceAsyncImpl

StepServiceImpl - class in com.openai.services.blocking.beta.threads.runs

StepServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.beta.threads.runs.StepServiceImpl

STOP - enum entry in com.openai.models.chat.completions.ChatCompletion.Choice.FinishReason.Known

STOP - enum entry in com.openai.models.chat.completions.ChatCompletion.Choice.FinishReason.Value

STOP - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.FinishReason.Known

STOP - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.FinishReason.Value

stop() - function in com.openai.models.chat.completions.ChatCompletionCreateParams

Up to 4 sequences where the API will stop generating further tokens.

stop() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body

Up to 4 sequences where the API will stop generating further tokens.

stop(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Sets Builder.stop to an arbitrary JSON value.

stop(com.openai.models.chat.completions.ChatCompletionCreateParams.Stop) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Up to 4 sequences where the API will stop generating further tokens.

stop(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling Builder.stop with stop.orElse(null).

stop(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling stop with Stop.ofString(string).

stop(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Sets Builder.stop to an arbitrary JSON value.

stop(com.openai.models.chat.completions.ChatCompletionCreateParams.Stop) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Up to 4 sequences where the API will stop generating further tokens.

stop(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling Builder.stop with stop.orElse(null).

stop(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling stop with Stop.ofString(string).

STOP - enum entry in com.openai.models.completions.CompletionChoice.FinishReason.Known

STOP - enum entry in com.openai.models.completions.CompletionChoice.FinishReason.Value

stop() - function in com.openai.models.completions.CompletionCreateParams

Up to 4 sequences where the API will stop generating further tokens.

stop() - function in com.openai.models.completions.CompletionCreateParams.Body

Up to 4 sequences where the API will stop generating further tokens.

stop(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Sets Builder.stop to an arbitrary JSON value.

stop(com.openai.models.completions.CompletionCreateParams.Stop) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Up to 4 sequences where the API will stop generating further tokens.

stop(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling Builder.stop with stop.orElse(null).

stop(java.lang.String) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling stop with Stop.ofString(string).

stop(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Builder

Sets Builder.stop to an arbitrary JSON value.

stop(com.openai.models.completions.CompletionCreateParams.Stop) - function in com.openai.models.completions.CompletionCreateParams.Builder

Up to 4 sequences where the API will stop generating further tokens.

stop(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling Builder.stop with stop.orElse(null).

stop(java.lang.String) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling stop with Stop.ofString(string).

stopOfStrings(java.util.List) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling stop with Stop.ofStrings(strings).

stopOfStrings(java.util.List) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling stop with Stop.ofStrings(strings).

stopOfStrings(java.util.List) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling stop with Stop.ofStrings(strings).

stopOfStrings(java.util.List) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling stop with Stop.ofStrings(strings).

store() - function in com.openai.models.chat.completions.ChatCompletionCreateParams

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

store() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

store(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Sets Builder.store to an arbitrary JSON value.

store(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling Builder.store with store.orElse(null).

store(java.lang.Boolean) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for Builder.store.

store(java.lang.Boolean) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

store(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Sets Builder.store to an arbitrary JSON value.

store(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling Builder.store with store.orElse(null).

store(java.lang.Boolean) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for Builder.store.

store(java.lang.Boolean) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

store() - function in com.openai.models.responses.ResponseCreateParams

Whether to store the generated model response for later retrieval via API.

store() - function in com.openai.models.responses.ResponseCreateParams.Body

Whether to store the generated model response for later retrieval via API.

store(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseCreateParams.Body.Builder

Sets Builder.store to an arbitrary JSON value.

store(java.util.Optional) - function in com.openai.models.responses.ResponseCreateParams.Body.Builder

Alias for calling Builder.store with store.orElse(null).

store(java.lang.Boolean) - function in com.openai.models.responses.ResponseCreateParams.Body.Builder

Alias for Builder.store.

store(java.lang.Boolean) - function in com.openai.models.responses.ResponseCreateParams.Body.Builder

Whether to store the generated model response for later retrieval via API.

store(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseCreateParams.Builder

Sets Builder.store to an arbitrary JSON value.

store(java.util.Optional) - function in com.openai.models.responses.ResponseCreateParams.Builder

Alias for calling Builder.store with store.orElse(null).

store(java.lang.Boolean) - function in com.openai.models.responses.ResponseCreateParams.Builder

Alias for Builder.store.

store(java.lang.Boolean) - function in com.openai.models.responses.ResponseCreateParams.Builder

Whether to store the generated model response for later retrieval via API.

storedCompletions() - function in com.openai.models.evals.EvalCreateParams.DataSourceConfig

A data source config which specifies the metadata property of your stored completions query.

storedCompletions() - function in com.openai.models.evals.EvalCreateResponse.DataSourceConfig

A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.

storedCompletions() - function in com.openai.models.evals.EvalListResponse.DataSourceConfig

A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.

storedCompletions() - function in com.openai.models.evals.EvalRetrieveResponse.DataSourceConfig

A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.

storedCompletions() - function in com.openai.models.evals.EvalUpdateResponse.DataSourceConfig

A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.

storedCompletions() - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Source

A StoredCompletionsRunDataSource configuration describing a set of filters

storedCompletionsDataSourceConfig(com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Schema) - function in com.openai.models.evals.EvalCreateResponse.Builder

Alias for calling dataSourceConfig with the following:

EvalStoredCompletionsDataSourceConfig.builder()
    .schema(schema)
    .build()

storedCompletionsDataSourceConfig(com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Schema) - function in com.openai.models.evals.EvalListResponse.Builder

Alias for calling dataSourceConfig with the following:

EvalStoredCompletionsDataSourceConfig.builder()
    .schema(schema)
    .build()

storedCompletionsDataSourceConfig(com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Schema) - function in com.openai.models.evals.EvalRetrieveResponse.Builder

Alias for calling dataSourceConfig with the following:

EvalStoredCompletionsDataSourceConfig.builder()
    .schema(schema)
    .build()

storedCompletionsDataSourceConfig(com.openai.models.evals.EvalStoredCompletionsDataSourceConfig.Schema) - function in com.openai.models.evals.EvalUpdateResponse.Builder

Alias for calling dataSourceConfig with the following:

EvalStoredCompletionsDataSourceConfig.builder()
    .schema(schema)
    .build()

stream() - function in com.openai.core.http.StreamResponse

stream() - function in com.openai.models.batches.BatchListPage.AutoPager

stream() - function in com.openai.models.beta.assistants.AssistantListPage.AutoPager

stream() - function in com.openai.models.beta.threads.messages.MessageListPage.AutoPager

stream() - function in com.openai.models.beta.threads.runs.RunListPage.AutoPager

stream() - function in com.openai.models.beta.threads.runs.steps.StepListPage.AutoPager

stream() - function in com.openai.models.chat.completions.ChatCompletionListPage.AutoPager

stream() - function in com.openai.models.chat.completions.messages.MessageListPage.AutoPager

stream() - function in com.openai.models.evals.EvalListPage.AutoPager

stream() - function in com.openai.models.evals.runs.RunListPage.AutoPager

stream() - function in com.openai.models.evals.runs.outputitems.OutputItemListPage.AutoPager

stream() - function in com.openai.models.files.FileListPage.AutoPager

stream() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePage.AutoPager

stream() - function in com.openai.models.finetuning.jobs.JobListEventsPage.AutoPager

stream() - function in com.openai.models.finetuning.jobs.JobListPage.AutoPager

stream() - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListPage.AutoPager

stream() - function in com.openai.models.models.ModelListPage.AutoPager

stream() - function in com.openai.models.responses.inputitems.InputItemListPage.AutoPager

stream() - function in com.openai.models.vectorstores.VectorStoreListPage.AutoPager

stream() - function in com.openai.models.vectorstores.VectorStoreSearchPage.AutoPager

stream() - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesPage.AutoPager

stream() - function in com.openai.models.vectorstores.files.FileContentPage.AutoPager

stream() - function in com.openai.models.vectorstores.files.FileListPage.AutoPager

streamHandlerExecutor() - function in com.openai.core.ClientOptions

streamHandlerExecutor(java.util.concurrent.Executor) - function in com.openai.core.ClientOptions.Builder

streamOptions() - function in com.openai.models.chat.completions.ChatCompletionCreateParams

Options for streaming response.

streamOptions() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body

Options for streaming response.

streamOptions(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Sets Builder.streamOptions to an arbitrary JSON value.

streamOptions(com.openai.models.chat.completions.ChatCompletionStreamOptions) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Options for streaming response.

streamOptions(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling Builder.streamOptions with streamOptions.orElse(null).

streamOptions(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Sets Builder.streamOptions to an arbitrary JSON value.

streamOptions(com.openai.models.chat.completions.ChatCompletionStreamOptions) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Options for streaming response.

streamOptions(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling Builder.streamOptions with streamOptions.orElse(null).

streamOptions() - function in com.openai.models.completions.CompletionCreateParams

Options for streaming response.

streamOptions() - function in com.openai.models.completions.CompletionCreateParams.Body

Options for streaming response.

streamOptions(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Sets Builder.streamOptions to an arbitrary JSON value.

streamOptions(com.openai.models.chat.completions.ChatCompletionStreamOptions) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Options for streaming response.

streamOptions(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling Builder.streamOptions with streamOptions.orElse(null).

streamOptions(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Builder

Sets Builder.streamOptions to an arbitrary JSON value.

streamOptions(com.openai.models.chat.completions.ChatCompletionStreamOptions) - function in com.openai.models.completions.CompletionCreateParams.Builder

Options for streaming response.

streamOptions(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling Builder.streamOptions with streamOptions.orElse(null).

StreamResponse - class in com.openai.core.http

strict() - function in com.openai.models.FunctionDefinition

Whether to enable strict schema adherence when generating the function call.

strict(com.openai.core.JsonField) - function in com.openai.models.FunctionDefinition.Builder

Sets Builder.strict to an arbitrary JSON value.

strict(java.util.Optional) - function in com.openai.models.FunctionDefinition.Builder

Alias for calling Builder.strict with strict.orElse(null).

strict(java.lang.Boolean) - function in com.openai.models.FunctionDefinition.Builder

Alias for Builder.strict.

strict(java.lang.Boolean) - function in com.openai.models.FunctionDefinition.Builder

Whether to enable strict schema adherence when generating the function call.

strict() - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema

Whether to enable strict schema adherence when generating the output.

strict(com.openai.core.JsonField) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

Sets Builder.strict to an arbitrary JSON value.

strict(java.util.Optional) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

Alias for calling Builder.strict with strict.orElse(null).

strict(java.lang.Boolean) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

Alias for Builder.strict.

strict(java.lang.Boolean) - function in com.openai.models.ResponseFormatJsonSchema.JsonSchema.Builder

Whether to enable strict schema adherence when generating the output.

strict() - function in com.openai.models.responses.FunctionTool

Whether to enforce strict parameter validation.

strict(com.openai.core.JsonField) - function in com.openai.models.responses.FunctionTool.Builder

Sets Builder.strict to an arbitrary JSON value.

strict(java.lang.Boolean) - function in com.openai.models.responses.FunctionTool.Builder

Whether to enforce strict parameter validation.

strict() - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig

Whether to enable strict schema adherence when generating the output.

strict(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

Sets Builder.strict to an arbitrary JSON value.

strict(java.util.Optional) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

Alias for calling Builder.strict with strict.orElse(null).

strict(java.lang.Boolean) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

Alias for Builder.strict.

strict(java.lang.Boolean) - function in com.openai.models.responses.ResponseFormatTextJsonSchemaConfig.Builder

Whether to enable strict schema adherence when generating the output.

string() - function in com.openai.models.AllModels

string() - function in com.openai.models.ComparisonFilter.Value

string() - function in com.openai.models.ResponsesModel

string() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Stop

string() - function in com.openai.models.completions.CompletionCreateParams.Prompt

string() - function in com.openai.models.completions.CompletionCreateParams.Stop

string() - function in com.openai.models.embeddings.EmbeddingCreateParams.Input

The string that will be turned into an embedding.

string() - function in com.openai.models.moderations.ModerationCreateParams.Input

A string of text to classify for moderation.

string() - function in com.openai.models.vectorstores.VectorStoreSearchParams.Query

stringCheck() - function in com.openai.models.evals.EvalCreateParams.TestingCriterion

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

stringCheck() - function in com.openai.models.evals.EvalCreateResponse.TestingCriterion

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

stringCheck() - function in com.openai.models.evals.EvalListResponse.TestingCriterion

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

stringCheck() - function in com.openai.models.evals.EvalRetrieveResponse.TestingCriterion

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

stringCheck() - function in com.openai.models.evals.EvalUpdateResponse.TestingCriterion

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

strings() - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Stop

strings() - function in com.openai.models.completions.CompletionCreateParams.Stop

strings() - function in com.openai.models.moderations.ModerationCreateParams.Input

An array of strings to classify for moderation.

strings() - function in com.openai.models.vectorstores.VectorStoreSearchParams.Query

style() - function in com.openai.models.images.ImageGenerateParams

The style of the generated images.

style() - function in com.openai.models.images.ImageGenerateParams.Body

The style of the generated images.

style(com.openai.core.JsonField) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

Sets Builder.style to an arbitrary JSON value.

style(com.openai.models.images.ImageGenerateParams.Style) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

The style of the generated images.

style(java.util.Optional) - function in com.openai.models.images.ImageGenerateParams.Body.Builder

Alias for calling Builder.style with style.orElse(null).

style(com.openai.core.JsonField) - function in com.openai.models.images.ImageGenerateParams.Builder

Sets Builder.style to an arbitrary JSON value.

style(com.openai.models.images.ImageGenerateParams.Style) - function in com.openai.models.images.ImageGenerateParams.Builder

The style of the generated images.

style(java.util.Optional) - function in com.openai.models.images.ImageGenerateParams.Builder

Alias for calling Builder.style with style.orElse(null).

submitToolOutputs() - function in com.openai.models.beta.threads.runs.Run.RequiredAction

Details on the tool outputs needed for this run to continue.

submitToolOutputs(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.Run.RequiredAction.Builder

Sets Builder.submitToolOutputs to an arbitrary JSON value.

submitToolOutputs(com.openai.models.beta.threads.runs.Run.RequiredAction.SubmitToolOutputs) - function in com.openai.models.beta.threads.runs.Run.RequiredAction.Builder

Details on the tool outputs needed for this run to continue.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsync

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunServiceAsync.submitToolOutputs.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunServiceAsync.submitToolOutputs.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsyncImpl

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunService

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunService.submitToolOutputs.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunService.submitToolOutputs.

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunServiceImpl

submitToolOutputs(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunServiceImpl.WithRawResponseImpl

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsync

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunServiceAsync.submitToolOutputsStreaming.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunServiceAsync.submitToolOutputsStreaming.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsync.WithRawResponse

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.async.beta.threads.RunServiceAsyncImpl

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunService

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunService.submitToolOutputsStreaming.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams) - function in com.openai.services.blocking.beta.threads.RunService.WithRawResponse

Returns a raw HTTP response for post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs, but is otherwise the same as RunService.submitToolOutputsStreaming.

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunServiceImpl

submitToolOutputsStreaming(com.openai.models.beta.threads.runs.RunSubmitToolOutputsParams,com.openai.core.RequestOptions) - function in com.openai.services.blocking.beta.threads.RunServiceImpl.WithRawResponseImpl

subscribe(com.openai.core.http.AsyncStreamResponse.Handler) - function in com.openai.core.http.AsyncStreamResponse

Registers handler to be called for events of this stream.

subscribe(com.openai.core.http.AsyncStreamResponse.Handler,java.util.concurrent.Executor) - function in com.openai.core.http.AsyncStreamResponse

Registers handler to be called for events of this stream.

SUCCEEDED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Status.Known

SUCCEEDED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Status.Value

suffix() - function in com.openai.models.completions.CompletionCreateParams

The suffix that comes after a completion of inserted text.

suffix() - function in com.openai.models.completions.CompletionCreateParams.Body

The suffix that comes after a completion of inserted text.

suffix(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Sets Builder.suffix to an arbitrary JSON value.

suffix(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for calling Builder.suffix with suffix.orElse(null).

suffix(java.lang.String) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

The suffix that comes after a completion of inserted text.

suffix(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionCreateParams.Builder

Sets Builder.suffix to an arbitrary JSON value.

suffix(java.util.Optional) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for calling Builder.suffix with suffix.orElse(null).

suffix(java.lang.String) - function in com.openai.models.completions.CompletionCreateParams.Builder

The suffix that comes after a completion of inserted text.

suffix() - function in com.openai.models.finetuning.jobs.JobCreateParams

A string of up to 64 characters that will be added to your fine-tuned model name.

suffix() - function in com.openai.models.finetuning.jobs.JobCreateParams.Body

A string of up to 64 characters that will be added to your fine-tuned model name.

suffix(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

Sets Builder.suffix to an arbitrary JSON value.

suffix(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

Alias for calling Builder.suffix with suffix.orElse(null).

suffix(java.lang.String) - function in com.openai.models.finetuning.jobs.JobCreateParams.Body.Builder

A string of up to 64 characters that will be added to your fine-tuned model name.

suffix(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

Sets Builder.suffix to an arbitrary JSON value.

suffix(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

Alias for calling Builder.suffix with suffix.orElse(null).

suffix(java.lang.String) - function in com.openai.models.finetuning.jobs.JobCreateParams.Builder

A string of up to 64 characters that will be added to your fine-tuned model name.

summary() - function in com.openai.models.responses.ResponseReasoningItem

Reasoning text contents.

summary(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseReasoningItem.Builder

Sets Builder.summary to an arbitrary JSON value.

summary(java.util.List) - function in com.openai.models.responses.ResponseReasoningItem.Builder

Reasoning text contents.

supervised() - function in com.openai.models.finetuning.jobs.FineTuningJob.Method

Configuration for the supervised fine-tuning method.

supervised(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.FineTuningJob.Method.Builder

Sets Builder.supervised to an arbitrary JSON value.

supervised(com.openai.models.finetuning.jobs.FineTuningJob.Method.Supervised) - function in com.openai.models.finetuning.jobs.FineTuningJob.Method.Builder

Configuration for the supervised fine-tuning method.

SUPERVISED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Method.Type.Known

SUPERVISED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Method.Type.Value

supervised() - function in com.openai.models.finetuning.jobs.JobCreateParams.Method

Configuration for the supervised fine-tuning method.

supervised(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.JobCreateParams.Method.Builder

Sets Builder.supervised to an arbitrary JSON value.

supervised(com.openai.models.finetuning.jobs.JobCreateParams.Method.Supervised) - function in com.openai.models.finetuning.jobs.JobCreateParams.Method.Builder

Configuration for the supervised fine-tuning method.

SUPERVISED - enum entry in com.openai.models.finetuning.jobs.JobCreateParams.Method.Type.Known

SUPERVISED - enum entry in com.openai.models.finetuning.jobs.JobCreateParams.Method.Type.Value

supportsUpdate(com.fasterxml.jackson.databind.DeserializationConfig) - function in com.fasterxml.jackson.databind.JsonDeserializer

sync() - function in com.openai.client.OpenAIClientAsync

Returns a version of this client that uses synchronous execution.

sync() - function in com.openai.client.OpenAIClientAsyncImpl

Returns a version of this client that uses synchronous execution.

SYSTEM - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.Role.Known

SYSTEM - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.Role.Value

system() - function in com.openai.models.chat.completions.ChatCompletionMessageParam

Developer-provided instructions that the model should follow, regardless of messages sent by the user.

SYSTEM - enum entry in com.openai.models.chat.completions.ChatCompletionRole.Known

SYSTEM - enum entry in com.openai.models.chat.completions.ChatCompletionRole.Value

SYSTEM - enum entry in com.openai.models.evals.EvalCreateParams.TestingCriterion.LabelModel.Input.InputMessage.Role.Known

SYSTEM - enum entry in com.openai.models.evals.EvalCreateParams.TestingCriterion.LabelModel.Input.InputMessage.Role.Value

SYSTEM - enum entry in com.openai.models.evals.EvalLabelModelGrader.Input.InputMessage.Role.Known

SYSTEM - enum entry in com.openai.models.evals.EvalLabelModelGrader.Input.InputMessage.Role.Value

SYSTEM - enum entry in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.InputMessages.Template.InnerTemplate.InputMessage.Role.Known

SYSTEM - enum entry in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.InputMessages.Template.InnerTemplate.InputMessage.Role.Value

SYSTEM - enum entry in com.openai.models.responses.EasyInputMessage.Role.Known

SYSTEM - enum entry in com.openai.models.responses.EasyInputMessage.Role.Value

SYSTEM - enum entry in com.openai.models.responses.ResponseInputItem.Message.Role.Known

SYSTEM - enum entry in com.openai.models.responses.ResponseInputItem.Message.Role.Value

SYSTEM - enum entry in com.openai.models.responses.ResponseInputMessageItem.Role.Known

SYSTEM - enum entry in com.openai.models.responses.ResponseInputMessageItem.Role.Value

systemFingerprint() - function in com.openai.models.chat.completions.ChatCompletion

This fingerprint represents the backend configuration that the model runs with.

systemFingerprint(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletion.Builder

Sets Builder.systemFingerprint to an arbitrary JSON value.

systemFingerprint(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletion.Builder

This fingerprint represents the backend configuration that the model runs with.

systemFingerprint() - function in com.openai.models.chat.completions.ChatCompletionChunk

This fingerprint represents the backend configuration that the model runs with.

systemFingerprint(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionChunk.Builder

Sets Builder.systemFingerprint to an arbitrary JSON value.

systemFingerprint(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionChunk.Builder

This fingerprint represents the backend configuration that the model runs with.

systemFingerprint() - function in com.openai.models.completions.Completion

This fingerprint represents the backend configuration that the model runs with.

systemFingerprint(com.openai.core.JsonField) - function in com.openai.models.completions.Completion.Builder

Sets Builder.systemFingerprint to an arbitrary JSON value.

systemFingerprint(java.lang.String) - function in com.openai.models.completions.Completion.Builder

This fingerprint represents the backend configuration that the model runs with.

A B C D E F G H I J K L M N O P Q R S T U V W X Y _