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  _ 

F

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

 

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

 

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

 

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

 

FAIL - enum entry in com.openai.models.evals.runs.outputitems.OutputItemListParams.Status.Known

 

FAIL - enum entry in com.openai.models.evals.runs.outputitems.OutputItemListParams.Status.Value

 

FAILED - enum entry in com.openai.models.batches.Batch.Status.Known

 

FAILED - enum entry in com.openai.models.batches.Batch.Status.Value

 

failed() - function in com.openai.models.batches.BatchRequestCounts

Number of requests that have failed.

failed(com.openai.core.JsonField) - function in com.openai.models.batches.BatchRequestCounts.Builder

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.batches.BatchRequestCounts.Builder

Number of requests that have failed.

FAILED - enum entry in com.openai.models.beta.threads.runs.RunStatus.Known

 

FAILED - enum entry in com.openai.models.beta.threads.runs.RunStatus.Value

 

FAILED - enum entry in com.openai.models.beta.threads.runs.steps.RunStep.Status.Known

 

FAILED - enum entry in com.openai.models.beta.threads.runs.steps.RunStep.Status.Value

 

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

Number of tests failed for this criteria.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunCancelResponse.PerTestingCriteriaResult.Builder

Number of tests failed for this criteria.

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

Number of output items that failed to pass the evaluation.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunCancelResponse.ResultCounts.Builder

Number of output items that failed to pass the evaluation.

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

Number of tests failed for this criteria.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunCreateResponse.PerTestingCriteriaResult.Builder

Number of tests failed for this criteria.

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

Number of output items that failed to pass the evaluation.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunCreateResponse.ResultCounts.Builder

Number of output items that failed to pass the evaluation.

FAILED - enum entry in com.openai.models.evals.runs.RunListParams.Status.Known

 

FAILED - enum entry in com.openai.models.evals.runs.RunListParams.Status.Value

 

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

Number of tests failed for this criteria.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunListResponse.PerTestingCriteriaResult.Builder

Number of tests failed for this criteria.

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

Number of output items that failed to pass the evaluation.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunListResponse.ResultCounts.Builder

Number of output items that failed to pass the evaluation.

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

Number of tests failed for this criteria.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunRetrieveResponse.PerTestingCriteriaResult.Builder

Number of tests failed for this criteria.

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

Number of output items that failed to pass the evaluation.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.evals.runs.RunRetrieveResponse.ResultCounts.Builder

Number of output items that failed to pass the evaluation.

FAILED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Status.Known

 

FAILED - enum entry in com.openai.models.finetuning.jobs.FineTuningJob.Status.Value

 

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

 

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

 

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

 

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

 

FAILED - enum entry in com.openai.models.responses.ResponseStatus.Known

 

FAILED - enum entry in com.openai.models.responses.ResponseStatus.Value

 

failed() - function in com.openai.models.responses.ResponseStreamEvent

An event that is emitted when a response fails.

failed() - function in com.openai.models.vectorstores.VectorStore.FileCounts

The number of files that have failed to process.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.vectorstores.VectorStore.FileCounts.Builder

The number of files that have failed to process.

FAILED - enum entry in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Filter.Known

 

FAILED - enum entry in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Filter.Value

 

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

The number of files that have failed to process.

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

Sets Builder.failed to an arbitrary JSON value.

failed(java.lang.Long) - function in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.FileCounts.Builder

The number of files that have failed to process.

FAILED - enum entry in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Status.Known

 

FAILED - enum entry in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Status.Value

 

FAILED - enum entry in com.openai.models.vectorstores.files.FileListParams.Filter.Known

 

FAILED - enum entry in com.openai.models.vectorstores.files.FileListParams.Filter.Value

 

FAILED - enum entry in com.openai.models.vectorstores.files.VectorStoreFile.Status.Known

 

FAILED - enum entry in com.openai.models.vectorstores.files.VectorStoreFile.Status.Value

 

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

 

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

 

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

The Unix timestamp (in seconds) for when the batch failed.

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

Sets Builder.failedAt to an arbitrary JSON value.

failedAt(java.lang.Long) - function in com.openai.models.batches.Batch.Builder

The Unix timestamp (in seconds) for when the batch failed.

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

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

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

Sets Builder.failedAt to an arbitrary JSON value.

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

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

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

Alias for Builder.failedAt.

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

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

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

The Unix timestamp (in seconds) for when the run step failed.

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

Sets Builder.failedAt to an arbitrary JSON value.

failedAt(java.util.Optional) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

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

failedAt(java.lang.Long) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

Alias for Builder.failedAt.

failedAt(java.lang.Long) - function in com.openai.models.beta.threads.runs.steps.RunStep.Builder

The Unix timestamp (in seconds) for when the run step failed.

file() - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file() - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Body

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(com.openai.core.MultipartField) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Body.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Body.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(java.nio.file.Path) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Body.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(kotlin.ByteArray) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Body.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(com.openai.core.MultipartField) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(java.nio.file.Path) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(kotlin.ByteArray) - function in com.openai.models.audio.transcriptions.TranscriptionCreateParams.Builder

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file() - function in com.openai.models.audio.translations.TranslationCreateParams

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file() - function in com.openai.models.audio.translations.TranslationCreateParams.Body

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(com.openai.core.MultipartField) - function in com.openai.models.audio.translations.TranslationCreateParams.Body.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.audio.translations.TranslationCreateParams.Body.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(java.nio.file.Path) - function in com.openai.models.audio.translations.TranslationCreateParams.Body.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(kotlin.ByteArray) - function in com.openai.models.audio.translations.TranslationCreateParams.Body.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(com.openai.core.MultipartField) - function in com.openai.models.audio.translations.TranslationCreateParams.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.audio.translations.TranslationCreateParams.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(java.nio.file.Path) - function in com.openai.models.audio.translations.TranslationCreateParams.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file(kotlin.ByteArray) - function in com.openai.models.audio.translations.TranslationCreateParams.Builder

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

file() - function in com.openai.models.chat.completions.ChatCompletionContentPart

Learn about file inputs for text generation.

file() - function in com.openai.models.chat.completions.ChatCompletionContentPart.File

 

file(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.Builder

Sets Builder.file to an arbitrary JSON value.

file(com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.Builder

 

file() - function in com.openai.models.files.FileCreateParams

The File object (not file name) to be uploaded.

file() - function in com.openai.models.files.FileCreateParams.Body

The File object (not file name) to be uploaded.

file(com.openai.core.MultipartField) - function in com.openai.models.files.FileCreateParams.Body.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.files.FileCreateParams.Body.Builder

The File object (not file name) to be uploaded.

file(java.nio.file.Path) - function in com.openai.models.files.FileCreateParams.Body.Builder

The File object (not file name) to be uploaded.

file(kotlin.ByteArray) - function in com.openai.models.files.FileCreateParams.Body.Builder

The File object (not file name) to be uploaded.

file(com.openai.core.MultipartField) - function in com.openai.models.files.FileCreateParams.Builder

Sets Builder.file to an arbitrary multipart value.

file(java.io.InputStream) - function in com.openai.models.files.FileCreateParams.Builder

The File object (not file name) to be uploaded.

file(java.nio.file.Path) - function in com.openai.models.files.FileCreateParams.Builder

The File object (not file name) to be uploaded.

file(kotlin.ByteArray) - function in com.openai.models.files.FileCreateParams.Builder

The File object (not file name) to be uploaded.

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

The File object represents a document that has been uploaded to OpenAI.

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

Sets Builder.file to an arbitrary JSON value.

file(com.openai.models.files.FileObject) - function in com.openai.models.uploads.Upload.Builder

The File object represents a document that has been uploaded to OpenAI.

file(java.util.Optional) - function in com.openai.models.uploads.Upload.Builder

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

FILE_SEARCH - enum entry in com.openai.models.beta.threads.AssistantToolChoice.Type.Known

 

FILE_SEARCH - enum entry in com.openai.models.beta.threads.AssistantToolChoice.Type.Value

 

FILE_SEARCH - enum entry in com.openai.models.responses.ToolChoiceTypes.Type.Known

 

FILE_SEARCH - enum entry in com.openai.models.responses.ToolChoiceTypes.Type.Value

 

FILE_SEARCH_CALL_RESULTS - enum entry in com.openai.models.responses.ResponseIncludable.Known

 

FILE_SEARCH_CALL_RESULTS - enum entry in com.openai.models.responses.ResponseIncludable.Value

 

FileBatchCancelParams - class in com.openai.models.vectorstores.filebatches

Cancel a vector store file batch.

FileBatchCancelParams.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchCancelParams

A builder for FileBatchCancelParams.

FileBatchCreateParams - class in com.openai.models.vectorstores.filebatches

Create a vector store file batch.

FileBatchCreateParams.Attributes - class in com.openai.models.vectorstores.filebatches.FileBatchCreateParams

Set of 16 key-value pairs that can be attached to an object.

FileBatchCreateParams.Attributes.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Attributes

A builder for Attributes.

FileBatchCreateParams.Body - class in com.openai.models.vectorstores.filebatches.FileBatchCreateParams

 

FileBatchCreateParams.Body.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Body

A builder for Body.

FileBatchCreateParams.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchCreateParams

A builder for FileBatchCreateParams.

fileBatches() - function in com.openai.services.async.VectorStoreServiceAsync

 

fileBatches() - function in com.openai.services.async.VectorStoreServiceAsync.WithRawResponse

 

fileBatches() - function in com.openai.services.async.VectorStoreServiceAsyncImpl

 

fileBatches() - function in com.openai.services.async.VectorStoreServiceAsyncImpl.WithRawResponseImpl

 

fileBatches() - function in com.openai.services.blocking.VectorStoreService

 

fileBatches() - function in com.openai.services.blocking.VectorStoreService.WithRawResponse

 

fileBatches() - function in com.openai.services.blocking.VectorStoreServiceImpl

 

fileBatches() - function in com.openai.services.blocking.VectorStoreServiceImpl.WithRawResponseImpl

 

FileBatchListFilesPage - class in com.openai.models.vectorstores.filebatches

 

FileBatchListFilesPage.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesPage

A builder for FileBatchListFilesPage.

FileBatchListFilesPageAsync - class in com.openai.models.vectorstores.filebatches

 

FileBatchListFilesPageAsync.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesPageAsync

A builder for FileBatchListFilesPageAsync.

FileBatchListFilesPageResponse - class in com.openai.models.vectorstores.filebatches

 

FileBatchListFilesPageResponse.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesPageResponse

A builder for FileBatchListFilesPageResponse.

FileBatchListFilesParams - class in com.openai.models.vectorstores.filebatches

Returns a list of vector store files in a batch.

FileBatchListFilesParams.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams

A builder for FileBatchListFilesParams.

FileBatchListFilesParams.Filter - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams

Filter by file status.

FileBatchListFilesParams.Filter.Known - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Filter

An enum containing Filter's known values.

FileBatchListFilesParams.Filter.Value - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Filter

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

FileBatchListFilesParams.Order - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams

Sort order by the created_at timestamp of the objects.

FileBatchListFilesParams.Order.Known - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Order

An enum containing Order's known values.

FileBatchListFilesParams.Order.Value - class in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Order

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

FileBatchRetrieveParams - class in com.openai.models.vectorstores.filebatches

Retrieves a vector store file batch.

FileBatchRetrieveParams.Builder - class in com.openai.models.vectorstores.filebatches.FileBatchRetrieveParams

A builder for FileBatchRetrieveParams.

FileBatchService - class in com.openai.services.blocking.vectorstores

 

FileBatchService.WithRawResponse - class in com.openai.services.blocking.vectorstores.FileBatchService

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

FileBatchServiceAsync - class in com.openai.services.async.vectorstores

 

FileBatchServiceAsync.WithRawResponse - class in com.openai.services.async.vectorstores.FileBatchServiceAsync

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

FileBatchServiceAsyncImpl - class in com.openai.services.async.vectorstores

 

FileBatchServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.vectorstores.FileBatchServiceAsyncImpl

 

FileBatchServiceImpl - class in com.openai.services.blocking.vectorstores

 

FileBatchServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.vectorstores.FileBatchServiceImpl

 

FileChunkingStrategy - class in com.openai.models.vectorstores

The strategy used to chunk the file.

FileChunkingStrategy.Visitor - class in com.openai.models.vectorstores.FileChunkingStrategy

An interface that defines how to map each variant of FileChunkingStrategy to a value of type T.

FileChunkingStrategyParam - class in com.openai.models.vectorstores

The chunking strategy used to chunk the file(s).

FileChunkingStrategyParam.Visitor - class in com.openai.models.vectorstores.FileChunkingStrategyParam

An interface that defines how to map each variant of FileChunkingStrategyParam to a value of type T.

fileCitation() - function in com.openai.models.beta.threads.messages.Annotation

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

fileCitation() - function in com.openai.models.beta.threads.messages.AnnotationDelta

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

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

 

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

Sets Builder.fileCitation to an arbitrary JSON value.

fileCitation(com.openai.models.beta.threads.messages.FileCitationAnnotation.FileCitation) - function in com.openai.models.beta.threads.messages.FileCitationAnnotation.Builder

 

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

 

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

Sets Builder.fileCitation to an arbitrary JSON value.

fileCitation(com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.FileCitation) - function in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.Builder

 

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

A citation to a file.

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

A citation to a file.

FileCitationAnnotation - class in com.openai.models.beta.threads.messages

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

FileCitationAnnotation.Builder - class in com.openai.models.beta.threads.messages.FileCitationAnnotation

A builder for FileCitationAnnotation.

FileCitationAnnotation.FileCitation - class in com.openai.models.beta.threads.messages.FileCitationAnnotation

 

FileCitationAnnotation.FileCitation.Builder - class in com.openai.models.beta.threads.messages.FileCitationAnnotation.FileCitation

A builder for FileCitation.

FileCitationDeltaAnnotation - class in com.openai.models.beta.threads.messages

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

FileCitationDeltaAnnotation.Builder - class in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation

A builder for FileCitationDeltaAnnotation.

FileCitationDeltaAnnotation.FileCitation - class in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation

 

FileCitationDeltaAnnotation.FileCitation.Builder - class in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.FileCitation

A builder for FileCitation.

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

 

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

 

fileContent() - function in com.openai.models.evals.runs.RunCancelResponse.DataSource.Responses.Source

 

fileContent() - function in com.openai.models.evals.runs.RunCreateParams.DataSource.CreateEvalResponsesRunDataSource.Source

 

fileContent() - function in com.openai.models.evals.runs.RunCreateResponse.DataSource.Responses.Source

 

fileContent() - function in com.openai.models.evals.runs.RunListResponse.DataSource.Responses.Source

 

fileContent() - function in com.openai.models.evals.runs.RunRetrieveResponse.DataSource.Responses.Source

 

fileContentCompletionsDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCancelResponse.Builder

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentCompletionsDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCreateResponse.Builder

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentCompletionsDataSource(java.util.List) - function in com.openai.models.evals.runs.RunListResponse.Builder

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentCompletionsDataSource(java.util.List) - function in com.openai.models.evals.runs.RunRetrieveResponse.Builder

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentJsonlDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCancelResponse.Builder

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentJsonlDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCreateResponse.Builder

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentJsonlDataSource(java.util.List) - function in com.openai.models.evals.runs.RunListResponse.Builder

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

fileContentJsonlDataSource(java.util.List) - function in com.openai.models.evals.runs.RunRetrieveResponse.Builder

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileContent.builder()
    .content(content)
    .build()

FileContentPage - class in com.openai.models.vectorstores.files

 

FileContentPage.Builder - class in com.openai.models.vectorstores.files.FileContentPage

A builder for FileContentPage.

FileContentPageAsync - class in com.openai.models.vectorstores.files

 

FileContentPageAsync.Builder - class in com.openai.models.vectorstores.files.FileContentPageAsync

A builder for FileContentPageAsync.

FileContentPageResponse - class in com.openai.models.vectorstores.files

Represents the parsed content of a vector store file.

FileContentPageResponse.Builder - class in com.openai.models.vectorstores.files.FileContentPageResponse

A builder for FileContentPageResponse.

FileContentParams - class in com.openai.models.files

Returns the contents of the specified file.

FileContentParams - class in com.openai.models.vectorstores.files

Retrieve the parsed contents of a vector store file.

FileContentParams.Builder - class in com.openai.models.files.FileContentParams

A builder for FileContentParams.

FileContentParams.Builder - class in com.openai.models.vectorstores.files.FileContentParams

A builder for FileContentParams.

FileContentResponse - class in com.openai.models.vectorstores.files

 

FileContentResponse.Builder - class in com.openai.models.vectorstores.files.FileContentResponse

A builder for FileContentResponse.

fileContentResponsesDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCancelResponse.Builder

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileContent.builder()
    .content(content)
    .build()

fileContentResponsesDataSource(java.util.List) - function in com.openai.models.evals.runs.RunCreateResponse.Builder

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileContent.builder()
    .content(content)
    .build()

fileContentResponsesDataSource(java.util.List) - function in com.openai.models.evals.runs.RunListResponse.Builder

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileContent.builder()
    .content(content)
    .build()

fileContentResponsesDataSource(java.util.List) - function in com.openai.models.evals.runs.RunRetrieveResponse.Builder

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.RunCancelResponse.DataSource.Responses.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.RunCreateParams.DataSource.CreateEvalResponsesRunDataSource.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.RunCreateResponse.DataSource.Responses.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.RunListResponse.DataSource.Responses.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

fileContentSource(java.util.List) - function in com.openai.models.evals.runs.RunRetrieveResponse.DataSource.Responses.Builder

Alias for calling source with the following:

Source.FileContent.builder()
    .content(content)
    .build()

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

 

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

Sets Builder.fileCounts to an arbitrary JSON value.

fileCounts(com.openai.models.vectorstores.VectorStore.FileCounts) - function in com.openai.models.vectorstores.VectorStore.Builder

 

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

 

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

Sets Builder.fileCounts to an arbitrary JSON value.

fileCounts(com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.FileCounts) - function in com.openai.models.vectorstores.filebatches.VectorStoreFileBatch.Builder

 

FileCreateParams - class in com.openai.models.files

Upload a file that can be used across various endpoints.

FileCreateParams - class in com.openai.models.vectorstores.files

Create a vector store file by attaching a File to a vector store.

FileCreateParams.Attributes - class in com.openai.models.vectorstores.files.FileCreateParams

Set of 16 key-value pairs that can be attached to an object.

FileCreateParams.Attributes.Builder - class in com.openai.models.vectorstores.files.FileCreateParams.Attributes

A builder for Attributes.

FileCreateParams.Body - class in com.openai.models.files.FileCreateParams

 

FileCreateParams.Body - class in com.openai.models.vectorstores.files.FileCreateParams

 

FileCreateParams.Body.Builder - class in com.openai.models.files.FileCreateParams.Body

A builder for Body.

FileCreateParams.Body.Builder - class in com.openai.models.vectorstores.files.FileCreateParams.Body

A builder for Body.

FileCreateParams.Builder - class in com.openai.models.files.FileCreateParams

A builder for FileCreateParams.

FileCreateParams.Builder - class in com.openai.models.vectorstores.files.FileCreateParams

A builder for FileCreateParams.

fileData() - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject

The base64 encoded file data, used when passing the file to the model as a string.

fileData(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

Sets Builder.fileData to an arbitrary JSON value.

fileData(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

The base64 encoded file data, used when passing the file to the model as a string.

fileData() - function in com.openai.models.responses.ResponseInputFile

The content of the file to be sent to the model.

fileData(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputFile.Builder

Sets Builder.fileData to an arbitrary JSON value.

fileData(java.lang.String) - function in com.openai.models.responses.ResponseInputFile.Builder

The content of the file to be sent to the model.

FileDeleted - class in com.openai.models.files

 

FileDeleted.Builder - class in com.openai.models.files.FileDeleted

A builder for FileDeleted.

FileDeleteParams - class in com.openai.models.files

Delete a file.

FileDeleteParams - class in com.openai.models.vectorstores.files

Delete a vector store file.

FileDeleteParams.Builder - class in com.openai.models.files.FileDeleteParams

A builder for FileDeleteParams.

FileDeleteParams.Builder - class in com.openai.models.vectorstores.files.FileDeleteParams

A builder for FileDeleteParams.

fileId() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.Message.Attachment

The ID of the file to attach to the message.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.Message.Attachment.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.Message.Attachment.Builder

The ID of the file to attach to the message.

fileId() - function in com.openai.models.beta.threads.ThreadCreateParams.Message.Attachment

The ID of the file to attach to the message.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateParams.Message.Attachment.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.ThreadCreateParams.Message.Attachment.Builder

The ID of the file to attach to the message.

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

The ID of the specific File the citation is from.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.FileCitationAnnotation.FileCitation.Builder

The ID of the specific File the citation is from.

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

The ID of the specific File the citation is from.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.FileCitationDeltaAnnotation.FileCitation.Builder

The ID of the specific File the citation is from.

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

The ID of the file that was generated.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.FilePathAnnotation.FilePath.Builder

The ID of the file that was generated.

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

The ID of the file that was generated.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.FilePath.Builder

The ID of the file that was generated.

fileId() - function in com.openai.models.beta.threads.messages.ImageFile

The File ID of the image in the message content.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.ImageFile.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.ImageFile.Builder

The File ID of the image in the message content.

fileId() - function in com.openai.models.beta.threads.messages.ImageFileDelta

The File ID of the image in the message content.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.ImageFileDelta.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.ImageFileDelta.Builder

The File ID of the image in the message content.

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

The ID of the file to attach to the message.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.Message.Attachment.Builder

The ID of the file to attach to the message.

fileId() - function in com.openai.models.beta.threads.messages.MessageCreateParams.Attachment

The ID of the file to attach to the message.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.MessageCreateParams.Attachment.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.messages.MessageCreateParams.Attachment.Builder

The ID of the file to attach to the message.

fileId() - function in com.openai.models.beta.threads.runs.RunCreateParams.AdditionalMessage.Attachment

The ID of the file to attach to the message.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.RunCreateParams.AdditionalMessage.Attachment.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.runs.RunCreateParams.AdditionalMessage.Attachment.Builder

The ID of the file to attach to the message.

fileId() - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterOutputImage.Image

The file ID of the image.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterOutputImage.Image.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterOutputImage.Image.Builder

The file ID of the image.

fileId() - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image

The file ID of the image.

fileId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.beta.threads.runs.steps.CodeInterpreterToolCall.CodeInterpreter.Output.ImageOutput.Image.Builder

The file ID of the image.

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

The ID of the file that result was found in.

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

Sets Builder.fileId to an arbitrary JSON value.

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

The ID of the file that result was found in.

fileId() - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject

The ID of an uploaded file to use as input.

fileId(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

The ID of an uploaded file to use as input.

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

 

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

 

fileId() - function in com.openai.models.evals.runs.RunCancelResponse.DataSource.Responses.Source

 

fileId() - function in com.openai.models.evals.runs.RunCreateParams.DataSource.CreateEvalResponsesRunDataSource.Source

 

fileId() - function in com.openai.models.evals.runs.RunCreateResponse.DataSource.Responses.Source

 

fileId() - function in com.openai.models.evals.runs.RunListResponse.DataSource.Responses.Source

 

fileId() - function in com.openai.models.evals.runs.RunRetrieveResponse.DataSource.Responses.Source

 

fileId() - function in com.openai.models.files.FileContentParams

 

fileId(java.util.Optional) - function in com.openai.models.files.FileContentParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.files.FileContentParams.Builder

 

fileId() - function in com.openai.models.files.FileDeleteParams

 

fileId(java.util.Optional) - function in com.openai.models.files.FileDeleteParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.files.FileDeleteParams.Builder

 

fileId() - function in com.openai.models.files.FileRetrieveParams

 

fileId(java.util.Optional) - function in com.openai.models.files.FileRetrieveParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.files.FileRetrieveParams.Builder

 

fileId() - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files.File

The ID of the file.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files.File.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files.File.Builder

The ID of the file.

fileId() - function in com.openai.models.responses.ResponseComputerToolCallOutputScreenshot

The identifier of an uploaded file that contains the screenshot.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseComputerToolCallOutputScreenshot.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseComputerToolCallOutputScreenshot.Builder

The identifier of an uploaded file that contains the screenshot.

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

The unique ID of the file.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseFileSearchToolCall.Result.Builder

The unique ID of the file.

fileId() - function in com.openai.models.responses.ResponseInputFile

The ID of the file to be sent to the model.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputFile.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.util.Optional) - function in com.openai.models.responses.ResponseInputFile.Builder

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

fileId(java.lang.String) - function in com.openai.models.responses.ResponseInputFile.Builder

The ID of the file to be sent to the model.

fileId() - function in com.openai.models.responses.ResponseInputImage

The ID of the file to be sent to the model.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputImage.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.util.Optional) - function in com.openai.models.responses.ResponseInputImage.Builder

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

fileId(java.lang.String) - function in com.openai.models.responses.ResponseInputImage.Builder

The ID of the file to be sent to the model.

fileId() - function in com.openai.models.responses.ResponseOutputText.Annotation.FileCitation

The ID of the file.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseOutputText.Annotation.FileCitation.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseOutputText.Annotation.FileCitation.Builder

The ID of the file.

fileId() - function in com.openai.models.responses.ResponseOutputText.Annotation.FilePath

The ID of the file.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseOutputText.Annotation.FilePath.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseOutputText.Annotation.FilePath.Builder

The ID of the file.

fileId() - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FileCitation

The ID of the file.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FileCitation.Builder

The ID of the file.

fileId() - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FilePath

The ID of the file.

fileId(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FilePath.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.responses.ResponseTextAnnotationDeltaEvent.Annotation.FilePath.Builder

The ID of the file.

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

The ID of the vector store file.

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

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.vectorstores.VectorStoreSearchResponse.Builder

The ID of the vector store file.

fileId() - function in com.openai.models.vectorstores.files.FileContentParams

 

fileId(java.util.Optional) - function in com.openai.models.vectorstores.files.FileContentParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileContentParams.Builder

 

fileId() - function in com.openai.models.vectorstores.files.FileCreateParams

A File ID that the vector store should use.

fileId() - function in com.openai.models.vectorstores.files.FileCreateParams.Body

A File ID that the vector store should use.

fileId(com.openai.core.JsonField) - function in com.openai.models.vectorstores.files.FileCreateParams.Body.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileCreateParams.Body.Builder

A File ID that the vector store should use.

fileId(com.openai.core.JsonField) - function in com.openai.models.vectorstores.files.FileCreateParams.Builder

Sets Builder.fileId to an arbitrary JSON value.

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileCreateParams.Builder

A File ID that the vector store should use.

fileId() - function in com.openai.models.vectorstores.files.FileDeleteParams

 

fileId(java.util.Optional) - function in com.openai.models.vectorstores.files.FileDeleteParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileDeleteParams.Builder

 

fileId() - function in com.openai.models.vectorstores.files.FileRetrieveParams

 

fileId(java.util.Optional) - function in com.openai.models.vectorstores.files.FileRetrieveParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileRetrieveParams.Builder

 

fileId() - function in com.openai.models.vectorstores.files.FileUpdateParams

 

fileId(java.util.Optional) - function in com.openai.models.vectorstores.files.FileUpdateParams.Builder

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

fileId(java.lang.String) - function in com.openai.models.vectorstores.files.FileUpdateParams.Builder

 

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

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling completionsDataSource with the following:

CreateEvalCompletionsRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling jsonlDataSource with the following:

CreateEvalJsonlRunDataSource.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling responsesDataSource with the following:

DataSource.Responses.Source.FileId.builder()
    .id(id)
    .build()

fileIds() - function in com.openai.models.beta.assistants.Assistant.ToolResources.CodeInterpreter

A list of file IDs made available to the `code_interpreter`` tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.Assistant.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.assistants.Assistant.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the `code_interpreter`` tool.

fileIds() - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

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

A list of file IDs to add to the vector store.

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

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch.VectorStore.Builder

A list of file IDs to add to the vector store.

fileIds() - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.CodeInterpreter

Overrides the list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.CodeInterpreter.Builder

Overrides the list of file IDs made available to the code_interpreter tool.

fileIds() - function in com.openai.models.beta.threads.Thread.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.threads.Thread.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.Thread.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

fileIds() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

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

A list of file IDs to add to the vector store.

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

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch.VectorStore.Builder

A list of file IDs to add to the vector store.

fileIds() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

fileIds() - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

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

A list of file IDs to add to the vector store.

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

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch.VectorStore.Builder

A list of file IDs to add to the vector store.

fileIds() - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.CodeInterpreter

A list of file IDs made available to the code_interpreter tool.

fileIds(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.CodeInterpreter.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.CodeInterpreter.Builder

A list of file IDs made available to the code_interpreter tool.

fileIds() - function in com.openai.models.vectorstores.VectorStoreCreateParams

A list of File IDs that the vector store should use.

fileIds() - function in com.openai.models.vectorstores.VectorStoreCreateParams.Body

A list of File IDs that the vector store should use.

fileIds(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Body.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Body.Builder

A list of File IDs that the vector store should use.

fileIds(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.vectorstores.VectorStoreCreateParams.Builder

A list of File IDs that the vector store should use.

fileIds() - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams

A list of File IDs that the vector store should use.

fileIds() - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Body

A list of File IDs that the vector store should use.

fileIds(com.openai.core.JsonField) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Body.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Body.Builder

A list of File IDs that the vector store should use.

fileIds(com.openai.core.JsonField) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Builder

Sets Builder.fileIds to an arbitrary JSON value.

fileIds(java.util.List) - function in com.openai.models.vectorstores.filebatches.FileBatchCreateParams.Builder

A list of File IDs that the vector store should use.

fileIdSource(java.lang.String) - function in com.openai.models.evals.runs.CreateEvalCompletionsRunDataSource.Builder

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

fileIdSource(java.lang.String) - function in com.openai.models.evals.runs.CreateEvalJsonlRunDataSource.Builder

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

fileIdSource(java.lang.String) - function in com.openai.models.evals.runs.RunCreateParams.DataSource.CreateEvalResponsesRunDataSource.Builder

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

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

Alias for calling source with the following:

Source.FileId.builder()
    .id(id)
    .build()

FileListPage - class in com.openai.models.files

 

FileListPage - class in com.openai.models.vectorstores.files

 

FileListPage.Builder - class in com.openai.models.files.FileListPage

A builder for FileListPage.

FileListPage.Builder - class in com.openai.models.vectorstores.files.FileListPage

A builder for FileListPage.

FileListPageAsync - class in com.openai.models.files

 

FileListPageAsync - class in com.openai.models.vectorstores.files

 

FileListPageAsync.Builder - class in com.openai.models.files.FileListPageAsync

A builder for FileListPageAsync.

FileListPageAsync.Builder - class in com.openai.models.vectorstores.files.FileListPageAsync

A builder for FileListPageAsync.

FileListPageResponse - class in com.openai.models.files

 

FileListPageResponse - class in com.openai.models.vectorstores.files

 

FileListPageResponse.Builder - class in com.openai.models.files.FileListPageResponse

A builder for FileListPageResponse.

FileListPageResponse.Builder - class in com.openai.models.vectorstores.files.FileListPageResponse

A builder for FileListPageResponse.

FileListParams - class in com.openai.models.files

Returns a list of files.

FileListParams - class in com.openai.models.vectorstores.files

Returns a list of vector store files.

FileListParams.Builder - class in com.openai.models.files.FileListParams

A builder for FileListParams.

FileListParams.Builder - class in com.openai.models.vectorstores.files.FileListParams

A builder for FileListParams.

FileListParams.Filter - class in com.openai.models.vectorstores.files.FileListParams

Filter by file status.

FileListParams.Filter.Known - class in com.openai.models.vectorstores.files.FileListParams.Filter

An enum containing Filter's known values.

FileListParams.Filter.Value - class in com.openai.models.vectorstores.files.FileListParams.Filter

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

FileListParams.Order - class in com.openai.models.files.FileListParams

Sort order by the created_at timestamp of the objects.

FileListParams.Order - class in com.openai.models.vectorstores.files.FileListParams

Sort order by the created_at timestamp of the objects.

FileListParams.Order.Known - class in com.openai.models.files.FileListParams.Order

An enum containing Order's known values.

FileListParams.Order.Known - class in com.openai.models.vectorstores.files.FileListParams.Order

An enum containing Order's known values.

FileListParams.Order.Value - class in com.openai.models.files.FileListParams.Order

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

FileListParams.Order.Value - class in com.openai.models.vectorstores.files.FileListParams.Order

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

filename() - function in com.openai.core.MultipartField

Returns the filename directive that will be included in the serialized field.

filename(java.util.Optional) - function in com.openai.core.MultipartField.Builder

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

filename(java.lang.String) - function in com.openai.core.MultipartField.Builder

 

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

The name of the file that result was found in.

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

Sets Builder.fileName to an arbitrary JSON value.

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

The name of the file that result was found in.

filename() - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject

The name of the file, used when passing the file to the model as a string.

filename(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionContentPart.File.FileObject.Builder

The name of the file, used when passing the file to the model as a string.

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

The name of the file.

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

Sets Builder.filename to an arbitrary JSON value.

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

The name of the file.

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

The name of the file.

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

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.responses.ResponseFileSearchToolCall.Result.Builder

The name of the file.

filename() - function in com.openai.models.responses.ResponseInputFile

The name of the file to be sent to the model.

filename(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputFile.Builder

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.responses.ResponseInputFile.Builder

The name of the file to be sent to the model.

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

The name of the file to be uploaded.

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

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.uploads.Upload.Builder

The name of the file to be uploaded.

filename() - function in com.openai.models.uploads.UploadCreateParams

The name of the file to upload.

filename() - function in com.openai.models.uploads.UploadCreateParams.Body

The name of the file to upload.

filename(com.openai.core.JsonField) - function in com.openai.models.uploads.UploadCreateParams.Body.Builder

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.uploads.UploadCreateParams.Body.Builder

The name of the file to upload.

filename(com.openai.core.JsonField) - function in com.openai.models.uploads.UploadCreateParams.Builder

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.uploads.UploadCreateParams.Builder

The name of the file to upload.

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

The name of the vector store file.

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

Sets Builder.filename to an arbitrary JSON value.

filename(java.lang.String) - function in com.openai.models.vectorstores.VectorStoreSearchResponse.Builder

The name of the vector store file.

FileObject - class in com.openai.models.files

The File object represents a document that has been uploaded to OpenAI.

FileObject.Builder - class in com.openai.models.files.FileObject

A builder for FileObject.

FileObject.Purpose - class in com.openai.models.files.FileObject

The intended purpose of the file.

FileObject.Purpose.Known - class in com.openai.models.files.FileObject.Purpose

An enum containing Purpose's known values.

FileObject.Purpose.Value - class in com.openai.models.files.FileObject.Purpose

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

FileObject.Status - class in com.openai.models.files.FileObject

Deprecated.

FileObject.Status.Known - class in com.openai.models.files.FileObject.Status

An enum containing Status's known values.

FileObject.Status.Value - class in com.openai.models.files.FileObject.Status

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

filePath() - function in com.openai.models.beta.threads.messages.Annotation

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

filePath() - function in com.openai.models.beta.threads.messages.AnnotationDelta

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

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

 

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

Sets Builder.filePath to an arbitrary JSON value.

filePath(com.openai.models.beta.threads.messages.FilePathAnnotation.FilePath) - function in com.openai.models.beta.threads.messages.FilePathAnnotation.Builder

 

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

 

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

Sets Builder.filePath to an arbitrary JSON value.

filePath(com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.FilePath) - function in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.Builder

 

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

A path to a file.

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

A path to a file.

FilePathAnnotation - class in com.openai.models.beta.threads.messages

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

FilePathAnnotation.Builder - class in com.openai.models.beta.threads.messages.FilePathAnnotation

A builder for FilePathAnnotation.

FilePathAnnotation.FilePath - class in com.openai.models.beta.threads.messages.FilePathAnnotation

 

FilePathAnnotation.FilePath.Builder - class in com.openai.models.beta.threads.messages.FilePathAnnotation.FilePath

A builder for FilePath.

FilePathDeltaAnnotation - class in com.openai.models.beta.threads.messages

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

FilePathDeltaAnnotation.Builder - class in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation

A builder for FilePathDeltaAnnotation.

FilePathDeltaAnnotation.FilePath - class in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation

 

FilePathDeltaAnnotation.FilePath.Builder - class in com.openai.models.beta.threads.messages.FilePathDeltaAnnotation.FilePath

A builder for FilePath.

FilePurpose - class in com.openai.models.files

The intended purpose of the uploaded file.

FilePurpose.Known - class in com.openai.models.files.FilePurpose

An enum containing FilePurpose's known values.

FilePurpose.Value - class in com.openai.models.files.FilePurpose

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

FileRetrieveParams - class in com.openai.models.files

Returns information about a specific file.

FileRetrieveParams - class in com.openai.models.vectorstores.files

Retrieves a vector store file.

FileRetrieveParams.Builder - class in com.openai.models.files.FileRetrieveParams

A builder for FileRetrieveParams.

FileRetrieveParams.Builder - class in com.openai.models.vectorstores.files.FileRetrieveParams

A builder for FileRetrieveParams.

files() - function in com.openai.client.OpenAIClient

 

files() - function in com.openai.client.OpenAIClient.WithRawResponse

 

files() - function in com.openai.client.OpenAIClientAsync

 

files() - function in com.openai.client.OpenAIClientAsync.WithRawResponse

 

files() - function in com.openai.client.OpenAIClientAsyncImpl

 

files() - function in com.openai.client.OpenAIClientAsyncImpl.WithRawResponseImpl

 

files() - function in com.openai.client.OpenAIClientImpl

 

files() - function in com.openai.client.OpenAIClientImpl.WithRawResponseImpl

 

files() - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result

The output of a code interpreter tool call that is a file.

files() - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files

 

files(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files.Builder

Sets Builder.files to an arbitrary JSON value.

files(java.util.List) - function in com.openai.models.responses.ResponseCodeInterpreterToolCall.Result.Files.Builder

 

files() - function in com.openai.services.async.VectorStoreServiceAsync

 

files() - function in com.openai.services.async.VectorStoreServiceAsync.WithRawResponse

 

files() - function in com.openai.services.async.VectorStoreServiceAsyncImpl

 

files() - function in com.openai.services.async.VectorStoreServiceAsyncImpl.WithRawResponseImpl

 

files() - function in com.openai.services.blocking.VectorStoreService

 

files() - function in com.openai.services.blocking.VectorStoreService.WithRawResponse

 

files() - function in com.openai.services.blocking.VectorStoreServiceImpl

 

files() - function in com.openai.services.blocking.VectorStoreServiceImpl.WithRawResponseImpl

 

fileSearch() - function in com.openai.models.beta.assistants.Assistant.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.Assistant.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.assistants.Assistant.ToolResources.FileSearch) - function in com.openai.models.beta.assistants.Assistant.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.FileSearch) - function in com.openai.models.beta.assistants.AssistantCreateParams.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.assistants.AssistantTool

 

fileSearch() - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.FileSearch) - function in com.openai.models.beta.assistants.AssistantUpdateParams.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.assistants.FileSearchTool

Overrides for the file search tool.

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.FileSearchTool.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.assistants.FileSearchTool.FileSearch) - function in com.openai.models.beta.assistants.FileSearchTool.Builder

Overrides for the file search tool.

fileSearch() - function in com.openai.models.beta.threads.Thread.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.threads.Thread.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.Thread.ToolResources.FileSearch) - function in com.openai.models.beta.threads.Thread.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.Message.Attachment.Tool

 

fileSearch() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.FileSearch) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.Thread.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.FileSearch) - function in com.openai.models.beta.threads.ThreadCreateAndRunParams.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.threads.ThreadCreateParams.Message.Attachment.Tool

 

fileSearch() - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.ThreadCreateParams.ToolResources.FileSearch) - function in com.openai.models.beta.threads.ThreadCreateParams.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources

 

fileSearch(com.openai.core.JsonField) - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.Builder

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.FileSearch) - function in com.openai.models.beta.threads.ThreadUpdateParams.ToolResources.Builder

 

fileSearch() - function in com.openai.models.beta.threads.messages.MessageCreateParams.Attachment.Tool

 

fileSearch() - function in com.openai.models.beta.threads.runs.RunCreateParams.AdditionalMessage.Attachment.Tool

 

fileSearch() - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall

For now, this is always going to be an empty object.

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

Sets Builder.fileSearch to an arbitrary JSON value.

fileSearch(com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.Builder

For now, this is always going to be an empty object.

fileSearch(com.openai.core.JsonValue) - function in com.openai.models.beta.threads.runs.steps.FileSearchToolCallDelta.Builder

For now, this is always going to be an empty object.

fileSearch() - function in com.openai.models.beta.threads.runs.steps.ToolCall

 

fileSearch() - function in com.openai.models.beta.threads.runs.steps.ToolCallDelta

 

fileSearch() - function in com.openai.models.responses.Tool

A tool that searches for relevant content from uploaded files.

fileSearchCall() - function in com.openai.models.responses.ResponseInputItem

The results of a file search tool call.

fileSearchCall() - function in com.openai.models.responses.ResponseItem

The results of a file search tool call.

fileSearchCall() - function in com.openai.models.responses.ResponseOutputItem

The results of a file search tool call.

fileSearchCall() - function in com.openai.models.responses.StructuredResponseOutputItem

 

fileSearchCallCompleted() - function in com.openai.models.responses.ResponseStreamEvent

Emitted when a file search call is completed (results found).

fileSearchCallInProgress() - function in com.openai.models.responses.ResponseStreamEvent

Emitted when a file search call is initiated.

fileSearchCallSearching() - function in com.openai.models.responses.ResponseStreamEvent

Emitted when a file search is currently searching.

FileSearchTool - class in com.openai.models.beta.assistants

 

FileSearchTool - class in com.openai.models.responses

A tool that searches for relevant content from uploaded files.

FileSearchTool.Builder - class in com.openai.models.beta.assistants.FileSearchTool

A builder for FileSearchTool.

FileSearchTool.Builder - class in com.openai.models.responses.FileSearchTool

A builder for FileSearchTool.

FileSearchTool.FileSearch - class in com.openai.models.beta.assistants.FileSearchTool

Overrides for the file search tool.

FileSearchTool.FileSearch.Builder - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch

A builder for FileSearch.

FileSearchTool.FileSearch.RankingOptions - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch

The ranking options for the file search.

FileSearchTool.FileSearch.RankingOptions.Builder - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions

A builder for RankingOptions.

FileSearchTool.FileSearch.RankingOptions.Ranker - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions

The ranker to use for the file search.

FileSearchTool.FileSearch.RankingOptions.Ranker.Known - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions.Ranker

An enum containing Ranker's known values.

FileSearchTool.FileSearch.RankingOptions.Ranker.Value - class in com.openai.models.beta.assistants.FileSearchTool.FileSearch.RankingOptions.Ranker

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

FileSearchTool.Filters - class in com.openai.models.responses.FileSearchTool

A filter to apply.

FileSearchTool.Filters.Visitor - class in com.openai.models.responses.FileSearchTool.Filters

An interface that defines how to map each variant of Filters to a value of type T.

FileSearchTool.RankingOptions - class in com.openai.models.responses.FileSearchTool

Ranking options for search.

FileSearchTool.RankingOptions.Builder - class in com.openai.models.responses.FileSearchTool.RankingOptions

A builder for RankingOptions.

FileSearchTool.RankingOptions.Ranker - class in com.openai.models.responses.FileSearchTool.RankingOptions

The ranker to use for the file search.

FileSearchTool.RankingOptions.Ranker.Known - class in com.openai.models.responses.FileSearchTool.RankingOptions.Ranker

An enum containing Ranker's known values.

FileSearchTool.RankingOptions.Ranker.Value - class in com.openai.models.responses.FileSearchTool.RankingOptions.Ranker

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

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

 

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

A builder for FileSearchToolCall.

FileSearchToolCall.FileSearch - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall

For now, this is always going to be an empty object.

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

A builder for FileSearch.

FileSearchToolCall.FileSearch.RankingOptions - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch

The ranking options for the file search.

FileSearchToolCall.FileSearch.RankingOptions.Builder - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions

A builder for RankingOptions.

FileSearchToolCall.FileSearch.RankingOptions.Ranker - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions

The ranker to use for the file search.

FileSearchToolCall.FileSearch.RankingOptions.Ranker.Known - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions.Ranker

An enum containing Ranker's known values.

FileSearchToolCall.FileSearch.RankingOptions.Ranker.Value - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.RankingOptions.Ranker

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

FileSearchToolCall.FileSearch.Result - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch

A result instance of the file search.

FileSearchToolCall.FileSearch.Result.Builder - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result

A builder for Result.

FileSearchToolCall.FileSearch.Result.Content - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result

 

FileSearchToolCall.FileSearch.Result.Content.Builder - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Content

A builder for Content.

FileSearchToolCall.FileSearch.Result.Content.Type - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Content

The type of the content.

FileSearchToolCall.FileSearch.Result.Content.Type.Known - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Content.Type

An enum containing Type's known values.

FileSearchToolCall.FileSearch.Result.Content.Type.Value - class in com.openai.models.beta.threads.runs.steps.FileSearchToolCall.FileSearch.Result.Content.Type

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

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

 

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

A builder for FileSearchToolCallDelta.

FileService - class in com.openai.services.blocking

 

FileService - class in com.openai.services.blocking.vectorstores

 

FileService.WithRawResponse - class in com.openai.services.blocking.FileService

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

FileService.WithRawResponse - class in com.openai.services.blocking.vectorstores.FileService

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

FileServiceAsync - class in com.openai.services.async

 

FileServiceAsync - class in com.openai.services.async.vectorstores

 

FileServiceAsync.WithRawResponse - class in com.openai.services.async.FileServiceAsync

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

FileServiceAsync.WithRawResponse - class in com.openai.services.async.vectorstores.FileServiceAsync

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

FileServiceAsyncImpl - class in com.openai.services.async

 

FileServiceAsyncImpl - class in com.openai.services.async.vectorstores

 

FileServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.FileServiceAsyncImpl

 

FileServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.vectorstores.FileServiceAsyncImpl

 

FileServiceImpl - class in com.openai.services.blocking

 

FileServiceImpl - class in com.openai.services.blocking.vectorstores

 

FileServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.FileServiceImpl

 

FileServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.vectorstores.FileServiceImpl

 

FileUpdateParams - class in com.openai.models.vectorstores.files

Update attributes on a vector store file.

FileUpdateParams.Attributes - class in com.openai.models.vectorstores.files.FileUpdateParams

Set of 16 key-value pairs that can be attached to an object.

FileUpdateParams.Attributes.Builder - class in com.openai.models.vectorstores.files.FileUpdateParams.Attributes

A builder for Attributes.

FileUpdateParams.Body - class in com.openai.models.vectorstores.files.FileUpdateParams

 

FileUpdateParams.Body.Builder - class in com.openai.models.vectorstores.files.FileUpdateParams.Body

A builder for Body.

FileUpdateParams.Builder - class in com.openai.models.vectorstores.files.FileUpdateParams

A builder for FileUpdateParams.

fillInStackTrace() - function in kotlin.Throwable

 

filter() - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams

Filter by file status.

filter(com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Filter) - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Builder

Filter by file status.

filter(java.util.Optional) - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesParams.Builder

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

filter() - function in com.openai.models.vectorstores.files.FileListParams

Filter by file status.

filter(com.openai.models.vectorstores.files.FileListParams.Filter) - function in com.openai.models.vectorstores.files.FileListParams.Builder

Filter by file status.

filter(java.util.Optional) - function in com.openai.models.vectorstores.files.FileListParams.Builder

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

filters() - function in com.openai.models.CompoundFilter

Array of filters to combine.

filters(com.openai.core.JsonField) - function in com.openai.models.CompoundFilter.Builder

Sets Builder.filters to an arbitrary JSON value.

filters(java.util.List) - function in com.openai.models.CompoundFilter.Builder

Array of filters to combine.

filters() - function in com.openai.models.responses.FileSearchTool

A filter to apply.

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

Sets Builder.filters to an arbitrary JSON value.

filters(com.openai.models.ComparisonFilter) - function in com.openai.models.responses.FileSearchTool.Builder

Alias for calling filters with Filters.ofComparisonFilter(comparisonFilter).

filters(com.openai.models.CompoundFilter) - function in com.openai.models.responses.FileSearchTool.Builder

Alias for calling filters with Filters.ofCompoundFilter(compoundFilter).

filters(com.openai.models.responses.FileSearchTool.Filters) - function in com.openai.models.responses.FileSearchTool.Builder

A filter to apply.

filters(java.util.Optional) - function in com.openai.models.responses.FileSearchTool.Builder

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

filters() - function in com.openai.models.vectorstores.VectorStoreSearchParams

A filter to apply based on file attributes.

filters() - function in com.openai.models.vectorstores.VectorStoreSearchParams.Body

A filter to apply based on file attributes.

filters(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Body.Builder

Sets Builder.filters to an arbitrary JSON value.

filters(com.openai.models.ComparisonFilter) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Body.Builder

Alias for calling filters with Filters.ofComparisonFilter(comparisonFilter).

filters(com.openai.models.CompoundFilter) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Body.Builder

Alias for calling filters with Filters.ofCompoundFilter(compoundFilter).

filters(com.openai.models.vectorstores.VectorStoreSearchParams.Filters) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Body.Builder

A filter to apply based on file attributes.

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

Sets Builder.filters to an arbitrary JSON value.

filters(com.openai.models.ComparisonFilter) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Builder

Alias for calling filters with Filters.ofComparisonFilter(comparisonFilter).

filters(com.openai.models.CompoundFilter) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Builder

Alias for calling filters with Filters.ofCompoundFilter(compoundFilter).

filters(com.openai.models.vectorstores.VectorStoreSearchParams.Filters) - function in com.openai.models.vectorstores.VectorStoreSearchParams.Builder

A filter to apply based on file attributes.

FINALIZING - enum entry in com.openai.models.batches.Batch.Status.Known

 

FINALIZING - enum entry in com.openai.models.batches.Batch.Status.Value

 

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

The Unix timestamp (in seconds) for when the batch started finalizing.

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

Sets Builder.finalizingAt to an arbitrary JSON value.

finalizingAt(java.lang.Long) - function in com.openai.models.batches.Batch.Builder

The Unix timestamp (in seconds) for when the batch started finalizing.

findBackReference(java.lang.String) - function in com.fasterxml.jackson.databind.JsonDeserializer

 

FINE_TUNE - enum entry in com.openai.models.files.FileObject.Purpose.Known

 

FINE_TUNE - enum entry in com.openai.models.files.FileObject.Purpose.Value

 

FINE_TUNE - enum entry in com.openai.models.files.FilePurpose.Known

 

FINE_TUNE - enum entry in com.openai.models.files.FilePurpose.Value

 

FINE_TUNE_RESULTS - enum entry in com.openai.models.files.FileObject.Purpose.Known

 

FINE_TUNE_RESULTS - enum entry in com.openai.models.files.FileObject.Purpose.Value

 

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

The name of the fine-tuned model that is being created.

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

Sets Builder.fineTunedModel to an arbitrary JSON value.

fineTunedModel(java.util.Optional) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

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

fineTunedModel(java.lang.String) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

The name of the fine-tuned model that is being created.

fineTunedModelCheckpoint() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams

 

fineTunedModelCheckpoint(java.util.Optional) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams.Builder

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

fineTunedModelCheckpoint(java.lang.String) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreateParams.Builder

 

fineTunedModelCheckpoint() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams

 

fineTunedModelCheckpoint(java.lang.String) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionDeleteParams.Builder

 

fineTunedModelCheckpoint() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams

 

fineTunedModelCheckpoint(java.util.Optional) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams.Builder

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

fineTunedModelCheckpoint(java.lang.String) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveParams.Builder

 

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

The name of the fine-tuned checkpoint model that is created.

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

Sets Builder.fineTunedModelCheckpoint to an arbitrary JSON value.

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

The name of the fine-tuned checkpoint model that is created.

fineTuning() - function in com.openai.client.OpenAIClient

 

fineTuning() - function in com.openai.client.OpenAIClient.WithRawResponse

 

fineTuning() - function in com.openai.client.OpenAIClientAsync

 

fineTuning() - function in com.openai.client.OpenAIClientAsync.WithRawResponse

 

fineTuning() - function in com.openai.client.OpenAIClientAsyncImpl

 

fineTuning() - function in com.openai.client.OpenAIClientAsyncImpl.WithRawResponseImpl

 

fineTuning() - function in com.openai.client.OpenAIClientImpl

 

fineTuning() - function in com.openai.client.OpenAIClientImpl.WithRawResponseImpl

 

FineTuningJob - class in com.openai.models.finetuning.jobs

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

FineTuningJob.Builder - class in com.openai.models.finetuning.jobs.FineTuningJob

A builder for FineTuningJob.

FineTuningJob.Error - class in com.openai.models.finetuning.jobs.FineTuningJob

For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.

FineTuningJob.Error.Builder - class in com.openai.models.finetuning.jobs.FineTuningJob.Error

A builder for Error.

FineTuningJob.Hyperparameters - class in com.openai.models.finetuning.jobs.FineTuningJob

The hyperparameters used for the fine-tuning job.

FineTuningJob.Hyperparameters.BatchSize - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters

Number of examples in each batch.

FineTuningJob.Hyperparameters.BatchSize.Visitor - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters.BatchSize

An interface that defines how to map each variant of BatchSize to a value of type T.

FineTuningJob.Hyperparameters.Builder - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters

A builder for Hyperparameters.

FineTuningJob.Hyperparameters.LearningRateMultiplier - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters

Scaling factor for the learning rate.

FineTuningJob.Hyperparameters.LearningRateMultiplier.Visitor - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters.LearningRateMultiplier

An interface that defines how to map each variant of LearningRateMultiplier to a value of type T.

FineTuningJob.Hyperparameters.NEpochs - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters

The number of epochs to train the model for.

FineTuningJob.Hyperparameters.NEpochs.Visitor - class in com.openai.models.finetuning.jobs.FineTuningJob.Hyperparameters.NEpochs

An interface that defines how to map each variant of NEpochs to a value of type T.

FineTuningJob.Metadata - class in com.openai.models.finetuning.jobs.FineTuningJob

Set of 16 key-value pairs that can be attached to an object.

FineTuningJob.Metadata.Builder - class in com.openai.models.finetuning.jobs.FineTuningJob.Metadata

A builder for Metadata.

FineTuningJob.Method - class in com.openai.models.finetuning.jobs.FineTuningJob

The method used for fine-tuning.

FineTuningJob.Method.Builder - class in com.openai.models.finetuning.jobs.FineTuningJob.Method

A builder for Method.

FineTuningJob.Method.Type - class in com.openai.models.finetuning.jobs.FineTuningJob.Method

The type of method.

FineTuningJob.Method.Type.Known - class in com.openai.models.finetuning.jobs.FineTuningJob.Method.Type

An enum containing Type's known values.

FineTuningJob.Method.Type.Value - class in com.openai.models.finetuning.jobs.FineTuningJob.Method.Type

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

FineTuningJob.Status - class 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.

FineTuningJob.Status.Known - class in com.openai.models.finetuning.jobs.FineTuningJob.Status

An enum containing Status's known values.

FineTuningJob.Status.Value - class in com.openai.models.finetuning.jobs.FineTuningJob.Status

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

FineTuningJobCheckpoint - class in com.openai.models.finetuning.jobs.checkpoints

The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use.

FineTuningJobCheckpoint.Builder - class in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint

A builder for FineTuningJobCheckpoint.

FineTuningJobCheckpoint.Metrics - class in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint

Metrics at the step number during the fine-tuning job.

FineTuningJobCheckpoint.Metrics.Builder - class in com.openai.models.finetuning.jobs.checkpoints.FineTuningJobCheckpoint.Metrics

A builder for Metrics.

FineTuningJobEvent - class in com.openai.models.finetuning.jobs

Fine-tuning job event object

FineTuningJobEvent.Builder - class in com.openai.models.finetuning.jobs.FineTuningJobEvent

A builder for FineTuningJobEvent.

FineTuningJobEvent.Level - class in com.openai.models.finetuning.jobs.FineTuningJobEvent

The log level of the event.

FineTuningJobEvent.Level.Known - class in com.openai.models.finetuning.jobs.FineTuningJobEvent.Level

An enum containing Level's known values.

FineTuningJobEvent.Level.Value - class in com.openai.models.finetuning.jobs.FineTuningJobEvent.Level

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

FineTuningJobEvent.Type - class in com.openai.models.finetuning.jobs.FineTuningJobEvent

The type of event.

FineTuningJobEvent.Type.Known - class in com.openai.models.finetuning.jobs.FineTuningJobEvent.Type

An enum containing Type's known values.

FineTuningJobEvent.Type.Value - class in com.openai.models.finetuning.jobs.FineTuningJobEvent.Type

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

fineTuningJobId() - function in com.openai.models.finetuning.jobs.JobCancelParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobCancelParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.JobCancelParams.Builder

 

fineTuningJobId() - function in com.openai.models.finetuning.jobs.JobListEventsParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobListEventsParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.JobListEventsParams.Builder

 

fineTuningJobId() - function in com.openai.models.finetuning.jobs.JobPauseParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobPauseParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.JobPauseParams.Builder

 

fineTuningJobId() - function in com.openai.models.finetuning.jobs.JobResumeParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobResumeParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.JobResumeParams.Builder

 

fineTuningJobId() - function in com.openai.models.finetuning.jobs.JobRetrieveParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.JobRetrieveParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.JobRetrieveParams.Builder

 

fineTuningJobId() - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListParams

 

fineTuningJobId(java.util.Optional) - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListParams.Builder

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

fineTuningJobId(java.lang.String) - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListParams.Builder

 

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

The name of the fine-tuning job that this checkpoint was created from.

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

Sets Builder.fineTuningJobId to an arbitrary JSON value.

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

The name of the fine-tuning job that this checkpoint was created from.

FineTuningJobWandbIntegration - class in com.openai.models.finetuning.jobs

The settings for your integration with Weights and Biases.

FineTuningJobWandbIntegration.Builder - class in com.openai.models.finetuning.jobs.FineTuningJobWandbIntegration

A builder for FineTuningJobWandbIntegration.

FineTuningJobWandbIntegrationObject - class in com.openai.models.finetuning.jobs

 

FineTuningJobWandbIntegrationObject.Builder - class in com.openai.models.finetuning.jobs.FineTuningJobWandbIntegrationObject

A builder for FineTuningJobWandbIntegrationObject.

FineTuningService - class in com.openai.services.blocking

 

FineTuningService.WithRawResponse - class in com.openai.services.blocking.FineTuningService

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

FineTuningServiceAsync - class in com.openai.services.async

 

FineTuningServiceAsync.WithRawResponse - class in com.openai.services.async.FineTuningServiceAsync

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

FineTuningServiceAsyncImpl - class in com.openai.services.async

 

FineTuningServiceAsyncImpl.WithRawResponseImpl - class in com.openai.services.async.FineTuningServiceAsyncImpl

 

FineTuningServiceImpl - class in com.openai.services.blocking

 

FineTuningServiceImpl.WithRawResponseImpl - class in com.openai.services.blocking.FineTuningServiceImpl

 

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

The Unix timestamp (in seconds) for when the fine-tuning job was finished.

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

Sets Builder.finishedAt to an arbitrary JSON value.

finishedAt(java.util.Optional) - function in com.openai.models.finetuning.jobs.FineTuningJob.Builder

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

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

Alias for Builder.finishedAt.

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

The Unix timestamp (in seconds) for when the fine-tuning job was finished.

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

The reason the model stopped generating tokens.

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

Sets Builder.finishReason to an arbitrary JSON value.

finishReason(com.openai.models.chat.completions.ChatCompletion.Choice.FinishReason) - function in com.openai.models.chat.completions.ChatCompletion.Choice.Builder

The reason the model stopped generating tokens.

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

The reason the model stopped generating tokens.

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

Sets Builder.finishReason to an arbitrary JSON value.

finishReason(com.openai.models.chat.completions.ChatCompletionChunk.Choice.FinishReason) - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Builder

The reason the model stopped generating tokens.

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

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

finishReason() - function in com.openai.models.chat.completions.StructuredChatCompletion.Choice

 

finishReason() - function in com.openai.models.completions.CompletionChoice

The reason the model stopped generating tokens.

finishReason(com.openai.core.JsonField) - function in com.openai.models.completions.CompletionChoice.Builder

Sets Builder.finishReason to an arbitrary JSON value.

finishReason(com.openai.models.completions.CompletionChoice.FinishReason) - function in com.openai.models.completions.CompletionChoice.Builder

The reason the model stopped generating tokens.

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

The reason why the sample generation was finished.

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

Sets Builder.finishReason to an arbitrary JSON value.

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

The reason why the sample generation was finished.

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

The reason why the sample generation was finished.

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

Sets Builder.finishReason to an arbitrary JSON value.

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

The reason why the sample generation was finished.

firstId() - function in com.openai.models.batches.BatchListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.batches.BatchListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.batches.BatchListPageResponse.Builder

 

firstId() - function in com.openai.models.beta.assistants.AssistantListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.AssistantListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.beta.assistants.AssistantListPageResponse.Builder

 

firstId() - function in com.openai.models.beta.threads.messages.MessageListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.messages.MessageListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.beta.threads.messages.MessageListPageResponse.Builder

 

firstId() - function in com.openai.models.beta.threads.runs.RunListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.beta.threads.runs.RunListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.beta.threads.runs.RunListPageResponse.Builder

 

firstId() - function in com.openai.models.beta.threads.runs.steps.StepListPageResponse

 

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

Sets Builder.firstId to an arbitrary JSON value.

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

 

firstId() - function in com.openai.models.chat.completions.ChatCompletionListPageResponse

The identifier of the first chat completion in the data array.

firstId(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.chat.completions.ChatCompletionListPageResponse.Builder

The identifier of the first chat completion in the data array.

firstId() - function in com.openai.models.chat.completions.messages.MessageListPageResponse

The identifier of the first chat message in the data array.

firstId(com.openai.core.JsonField) - function in com.openai.models.chat.completions.messages.MessageListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.chat.completions.messages.MessageListPageResponse.Builder

The identifier of the first chat message in the data array.

firstId() - function in com.openai.models.evals.EvalListPageResponse

The identifier of the first eval in the data array.

firstId(com.openai.core.JsonField) - function in com.openai.models.evals.EvalListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.evals.EvalListPageResponse.Builder

The identifier of the first eval in the data array.

firstId() - function in com.openai.models.evals.runs.RunListPageResponse

The identifier of the first eval run in the data array.

firstId(com.openai.core.JsonField) - function in com.openai.models.evals.runs.RunListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.evals.runs.RunListPageResponse.Builder

The identifier of the first eval run in the data array.

firstId() - function in com.openai.models.evals.runs.outputitems.OutputItemListPageResponse

The identifier of the first eval run output item in the data array.

firstId(com.openai.core.JsonField) - function in com.openai.models.evals.runs.outputitems.OutputItemListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

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

The identifier of the first eval run output item in the data array.

firstId() - function in com.openai.models.files.FileListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.files.FileListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.files.FileListPageResponse.Builder

 

firstId() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.util.Optional) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePageResponse.Builder

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

firstId(java.lang.String) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionCreatePageResponse.Builder

 

firstId() - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.util.Optional) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse.Builder

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

firstId(java.lang.String) - function in com.openai.models.finetuning.checkpoints.permissions.PermissionRetrieveResponse.Builder

 

firstId() - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.util.Optional) - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListPageResponse.Builder

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

firstId(java.lang.String) - function in com.openai.models.finetuning.jobs.checkpoints.CheckpointListPageResponse.Builder

 

firstId() - function in com.openai.models.responses.inputitems.ResponseItemList

The ID of the first item in the list.

firstId(com.openai.core.JsonField) - function in com.openai.models.responses.inputitems.ResponseItemList.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.responses.inputitems.ResponseItemList.Builder

The ID of the first item in the list.

firstId() - function in com.openai.models.vectorstores.VectorStoreListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.vectorstores.VectorStoreListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.vectorstores.VectorStoreListPageResponse.Builder

 

firstId() - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.vectorstores.filebatches.FileBatchListFilesPageResponse.Builder

 

firstId() - function in com.openai.models.vectorstores.files.FileListPageResponse

 

firstId(com.openai.core.JsonField) - function in com.openai.models.vectorstores.files.FileListPageResponse.Builder

Sets Builder.firstId to an arbitrary JSON value.

firstId(java.lang.String) - function in com.openai.models.vectorstores.files.FileListPageResponse.Builder

 

FLAC - enum entry in com.openai.models.audio.speech.SpeechCreateParams.ResponseFormat.Known

 

FLAC - enum entry in com.openai.models.audio.speech.SpeechCreateParams.ResponseFormat.Value

 

FLAC - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Format.Known

 

FLAC - enum entry in com.openai.models.chat.completions.ChatCompletionAudioParam.Format.Value

 

flagged() - function in com.openai.models.moderations.Moderation

Whether any of the below categories are flagged.

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

Sets Builder.flagged to an arbitrary JSON value.

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

Whether any of the below categories are flagged.

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

 

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

 

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

 

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

 

FLEX - enum entry in com.openai.models.chat.completions.ChatCompletionCreateParams.ServiceTier.Known

 

FLEX - enum entry in com.openai.models.chat.completions.ChatCompletionCreateParams.ServiceTier.Value

 

FLEX - enum entry in com.openai.models.responses.Response.ServiceTier.Known

 

FLEX - enum entry in com.openai.models.responses.Response.ServiceTier.Value

 

FLEX - enum entry in com.openai.models.responses.ResponseCreateParams.ServiceTier.Known

 

FLEX - enum entry in com.openai.models.responses.ResponseCreateParams.ServiceTier.Value

 

FLOAT - enum entry in com.openai.models.embeddings.EmbeddingCreateParams.EncodingFormat.Known

 

FLOAT - enum entry in com.openai.models.embeddings.EmbeddingCreateParams.EncodingFormat.Value

 

forEach(java.util.function.Consumer) - function in kotlin.collections.Iterable

 

format() - function in com.openai.models.chat.completions.ChatCompletionAudioParam

Specifies the output audio format.

format(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionAudioParam.Builder

Sets Builder.format to an arbitrary JSON value.

format(com.openai.models.chat.completions.ChatCompletionAudioParam.Format) - function in com.openai.models.chat.completions.ChatCompletionAudioParam.Builder

Specifies the output audio format.

format() - function in com.openai.models.chat.completions.ChatCompletionContentPartInputAudio.InputAudio

The format of the encoded audio data.

format(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionContentPartInputAudio.InputAudio.Builder

Sets Builder.format to an arbitrary JSON value.

format(com.openai.models.chat.completions.ChatCompletionContentPartInputAudio.InputAudio.Format) - function in com.openai.models.chat.completions.ChatCompletionContentPartInputAudio.InputAudio.Builder

The format of the encoded audio data.

format() - function in com.openai.models.responses.ResponseInputAudio

The format of the audio data.

format(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseInputAudio.Builder

Sets Builder.format to an arbitrary JSON value.

format(com.openai.models.responses.ResponseInputAudio.Format) - function in com.openai.models.responses.ResponseInputAudio.Builder

The format of the audio data.

format() - function in com.openai.models.responses.ResponseTextConfig

An object specifying the format that the model must output.

format(com.openai.core.JsonField) - function in com.openai.models.responses.ResponseTextConfig.Builder

Sets Builder.format to an arbitrary JSON value.

format(com.openai.models.ResponseFormatJsonObject) - function in com.openai.models.responses.ResponseTextConfig.Builder

Alias for calling format with ResponseFormatTextConfig.ofJsonObject(jsonObject).

format(com.openai.models.ResponseFormatText) - function in com.openai.models.responses.ResponseTextConfig.Builder

Alias for calling format with ResponseFormatTextConfig.ofText(text).

format(com.openai.models.responses.ResponseFormatTextConfig) - function in com.openai.models.responses.ResponseTextConfig.Builder

An object specifying the format that the model must output.

format(com.openai.models.responses.ResponseFormatTextJsonSchemaConfig) - function in com.openai.models.responses.ResponseTextConfig.Builder

Alias for calling format with ResponseFormatTextConfig.ofJsonSchema(jsonSchema).

formulaParseError() - function in com.openai.models.finetuning.alpha.graders.GraderRunResponse.Metadata.Errors

 

formulaParseError(com.openai.core.JsonField) - function in com.openai.models.finetuning.alpha.graders.GraderRunResponse.Metadata.Errors.Builder

Sets Builder.formulaParseError to an arbitrary JSON value.

formulaParseError(java.lang.Boolean) - function in com.openai.models.finetuning.alpha.graders.GraderRunResponse.Metadata.Errors.Builder

 

FORWARD - enum entry in com.openai.models.responses.ResponseComputerToolCall.Action.Click.Button.Known

 

FORWARD - enum entry in com.openai.models.responses.ResponseComputerToolCall.Action.Click.Button.Value

 

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

Number between -2.0 and 2.0.

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

Number between -2.0 and 2.0.

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

Sets Builder.frequencyPenalty to an arbitrary JSON value.

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

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

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

Alias for Builder.frequencyPenalty.

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

Number between -2.0 and 2.0.

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

Sets Builder.frequencyPenalty to an arbitrary JSON value.

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

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

frequencyPenalty(java.lang.Double) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for Builder.frequencyPenalty.

frequencyPenalty(java.lang.Double) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Number between -2.0 and 2.0.

frequencyPenalty(com.openai.core.JsonField) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

frequencyPenalty(java.util.Optional) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

frequencyPenalty(java.lang.Double) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

frequencyPenalty(java.lang.Double) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

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

Number between -2.0 and 2.0.

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

Number between -2.0 and 2.0.

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

Sets Builder.frequencyPenalty to an arbitrary JSON value.

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

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

frequencyPenalty(java.lang.Double) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Alias for Builder.frequencyPenalty.

frequencyPenalty(java.lang.Double) - function in com.openai.models.completions.CompletionCreateParams.Body.Builder

Number between -2.0 and 2.0.

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

Sets Builder.frequencyPenalty to an arbitrary JSON value.

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

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

frequencyPenalty(java.lang.Double) - function in com.openai.models.completions.CompletionCreateParams.Builder

Alias for Builder.frequencyPenalty.

frequencyPenalty(java.lang.Double) - function in com.openai.models.completions.CompletionCreateParams.Builder

Number between -2.0 and 2.0.

from(com.openai.core.Page) - function in com.openai.core.AutoPager.Companion

 

from(com.openai.core.PageAsync,java.util.concurrent.Executor) - function in com.openai.core.AutoPagerAsync.Companion

 

from(java.lang.Object) - function in com.openai.core.JsonValue.Companion

Converts the given value to a JsonValue.

fromEnv() - function in com.openai.core.ClientOptions.Builder

 

fromEnv() - function in com.openai.core.ClientOptions.Companion

 

fromJsonNode(com.fasterxml.jackson.databind.JsonNode) - function in com.openai.core.JsonValue.Companion

Returns a JsonValue converted from the given Jackson JsonNode.

fromString(java.lang.String) - function in com.openai.azure.AzureOpenAIServiceVersion.Companion

 

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

 

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

Sets Builder.fullValidLoss to an arbitrary JSON value.

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

 

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

 

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

Sets Builder.fullValidMeanTokenAccuracy to an arbitrary JSON value.

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

 

function() - function in com.openai.models.beta.assistants.AssistantTool

 

function() - function in com.openai.models.beta.assistants.FunctionTool

 

function(com.openai.core.JsonField) - function in com.openai.models.beta.assistants.FunctionTool.Builder

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.FunctionDefinition) - function in com.openai.models.beta.assistants.FunctionTool.Builder

 

function() - function in com.openai.models.beta.threads.AssistantToolChoice

 

function(com.openai.core.JsonField) - function in com.openai.models.beta.threads.AssistantToolChoice.Builder

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.beta.threads.AssistantToolChoiceFunction) - function in com.openai.models.beta.threads.AssistantToolChoice.Builder

 

FUNCTION - enum entry in com.openai.models.beta.threads.AssistantToolChoice.Type.Known

 

FUNCTION - enum entry in com.openai.models.beta.threads.AssistantToolChoice.Type.Value

 

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

The function definition.

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.beta.threads.runs.RequiredActionFunctionToolCall.Function) - function in com.openai.models.beta.threads.runs.RequiredActionFunctionToolCall.Builder

The function definition.

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

The definition of the function that was called.

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.beta.threads.runs.steps.FunctionToolCall.Function) - function in com.openai.models.beta.threads.runs.steps.FunctionToolCall.Builder

The definition of the function that was called.

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

The definition of the function that was called.

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.beta.threads.runs.steps.FunctionToolCallDelta.Function) - function in com.openai.models.beta.threads.runs.steps.FunctionToolCallDelta.Builder

The definition of the function that was called.

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

 

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

 

function() - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall

 

function(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall.Builder

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall.Function) - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall.Builder

 

FUNCTION - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall.Type.Known

 

FUNCTION - enum entry in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.ToolCall.Type.Value

 

function() - function in com.openai.models.chat.completions.ChatCompletionMessageParam

 

function() - function in com.openai.models.chat.completions.ChatCompletionMessageToolCall

The function that the model called.

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.chat.completions.ChatCompletionMessageToolCall.Function) - function in com.openai.models.chat.completions.ChatCompletionMessageToolCall.Builder

The function that the model called.

function() - function in com.openai.models.chat.completions.ChatCompletionNamedToolChoice

 

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.chat.completions.ChatCompletionNamedToolChoice.Function) - function in com.openai.models.chat.completions.ChatCompletionNamedToolChoice.Builder

 

FUNCTION - enum entry in com.openai.models.chat.completions.ChatCompletionRole.Known

 

FUNCTION - enum entry in com.openai.models.chat.completions.ChatCompletionRole.Value

 

function() - function in com.openai.models.chat.completions.ChatCompletionTool

 

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

Sets Builder.function to an arbitrary JSON value.

function(com.openai.models.FunctionDefinition) - function in com.openai.models.chat.completions.ChatCompletionTool.Builder

 

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

Use this option to force the model to call a specific function.

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

Use this option to force the model to call a specific function.

function() - function in com.openai.models.responses.Tool

Defines a function in your own code the model can choose to call.

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

 

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

 

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

 

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

 

functionCall() - function in com.openai.models.chat.completions.ChatCompletionAssistantMessageParam

Deprecated and replaced by tool_calls.

functionCall(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionAssistantMessageParam.Builder

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionAssistantMessageParam.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionAssistantMessageParam.Builder

Deprecated and replaced by tool_calls.

functionCall(java.util.Optional) - function in com.openai.models.chat.completions.ChatCompletionAssistantMessageParam.Builder

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

functionCall() - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta

Deprecated and replaced by tool_calls.

functionCall(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.Builder

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionChunk.Choice.Delta.Builder

Deprecated and replaced by tool_calls.

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

Deprecated in favor of tool_choice.

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

Deprecated in favor of tool_choice.

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

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Deprecated in favor of tool_choice.

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall.FunctionCallMode) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling functionCall with FunctionCall.ofMode(mode).

functionCall(com.openai.models.chat.completions.ChatCompletionFunctionCallOption) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Body.Builder

Alias for calling functionCall with FunctionCall.ofFunctionCallOption(functionCallOption).

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

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Deprecated in favor of tool_choice.

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall.FunctionCallMode) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling functionCall with FunctionCall.ofMode(mode).

functionCall(com.openai.models.chat.completions.ChatCompletionFunctionCallOption) - function in com.openai.models.chat.completions.ChatCompletionCreateParams.Builder

Alias for calling functionCall with FunctionCall.ofFunctionCallOption(functionCallOption).

functionCall() - function in com.openai.models.chat.completions.ChatCompletionMessage

Deprecated and replaced by tool_calls.

functionCall(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionMessage.Builder

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionMessage.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionMessage.Builder

Deprecated and replaced by tool_calls.

functionCall() - function in com.openai.models.chat.completions.ChatCompletionStoreMessage

Deprecated and replaced by tool_calls.

functionCall(com.openai.core.JsonField) - function in com.openai.models.chat.completions.ChatCompletionStoreMessage.Builder

Sets Builder.functionCall to an arbitrary JSON value.

functionCall(com.openai.models.chat.completions.ChatCompletionMessage.FunctionCall) - function in com.openai.models.chat.completions.ChatCompletionStoreMessage.Builder

Deprecated and replaced by tool_calls.

functionCall(com.openai.core.JsonField) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

functionCall(com.openai.models.chat.completions.ChatCompletionCreateParams.FunctionCall.FunctionCallMode) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

functionCall(com.openai.models.chat.completions.ChatCompletionFunctionCallOption) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

functionCall() - function in com.openai.models.chat.completions.StructuredChatCompletionMessage

 

functionCall() - function in com.openai.models.responses.ResponseInputItem

A tool call to run a function.

functionCall() - function in com.openai.models.responses.ResponseItem

A tool call to run a function.

functionCall() - function in com.openai.models.responses.ResponseOutputItem

A tool call to run a function.

functionCall() - function in com.openai.models.responses.StructuredResponseOutputItem

 

functionCallArgumentsDelta() - function in com.openai.models.responses.ResponseStreamEvent

Emitted when there is a partial function-call arguments delta.

functionCallArgumentsDone() - function in com.openai.models.responses.ResponseStreamEvent

Emitted when function-call arguments are finalized.

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

Specifying a particular function via {"name": "my_function"} forces the model to call that function.

functionCallOutput() - function in com.openai.models.responses.ResponseInputItem

The output of a function tool call.

functionCallOutput() - function in com.openai.models.responses.ResponseItem

 

FunctionDefinition - class in com.openai.models

 

FunctionDefinition.Builder - class in com.openai.models.FunctionDefinition

A builder for FunctionDefinition.

FunctionParameters - class in com.openai.models

The parameters the functions accepts, described as a JSON Schema object.

FunctionParameters.Builder - class in com.openai.models.FunctionParameters

A builder for FunctionParameters.

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

Deprecated in favor of tools.

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

Deprecated in favor of tools.

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

Sets Builder.functions to an arbitrary JSON value.

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

Deprecated in favor of tools.

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

Sets Builder.functions to an arbitrary JSON value.

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

Deprecated in favor of tools.

functions(com.openai.core.JsonField) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

functions(java.util.List) - function in com.openai.models.chat.completions.StructuredChatCompletionCreateParams.Builder

 

FunctionTool - class in com.openai.models.beta.assistants

 

FunctionTool - class in com.openai.models.responses

Defines a function in your own code the model can choose to call.

FunctionTool.Builder - class in com.openai.models.beta.assistants.FunctionTool

A builder for FunctionTool.

FunctionTool.Builder - class in com.openai.models.responses.FunctionTool

A builder for FunctionTool.

FunctionTool.Parameters - class in com.openai.models.responses.FunctionTool

A JSON schema object describing the parameters of the function.

FunctionTool.Parameters.Builder - class in com.openai.models.responses.FunctionTool.Parameters

A builder for Parameters.

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

 

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

A builder for FunctionToolCall.

FunctionToolCall.Function - class in com.openai.models.beta.threads.runs.steps.FunctionToolCall

The definition of the function that was called.

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

A builder for Function.

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

 

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

A builder for FunctionToolCallDelta.

FunctionToolCallDelta.Function - class in com.openai.models.beta.threads.runs.steps.FunctionToolCallDelta

The definition of the function that was called.

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

A builder for Function.

FUZZY_MATCH - enum entry in com.openai.models.graders.gradermodels.TextSimilarityGrader.EvaluationMetric.Known

 

FUZZY_MATCH - enum entry in com.openai.models.graders.gradermodels.TextSimilarityGrader.EvaluationMetric.Value

 

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  _