Class CompletionServiceAsyncImpl
-
- All Implemented Interfaces:
-
com.openai.services.async.chat.CompletionServiceAsync
public final class CompletionServiceAsyncImpl implements CompletionServiceAsync
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
CompletionServiceAsyncImpl.WithRawResponseImpl
-
Method Summary
Modifier and Type Method Description CompletionServiceAsync.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. MessageServiceAsync
messages()
CompletableFuture<ChatCompletion>
create(ChatCompletionCreateParams params, RequestOptions requestOptions)
Creates a model response for the given chat conversation. AsyncStreamResponse<ChatCompletionChunk>
createStreaming(ChatCompletionCreateParams params, RequestOptions requestOptions)
Creates a model response for the given chat conversation. CompletableFuture<ChatCompletion>
retrieve(ChatCompletionRetrieveParams params, RequestOptions requestOptions)
Get a stored chat completion. CompletableFuture<ChatCompletion>
update(ChatCompletionUpdateParams params, RequestOptions requestOptions)
Modify a stored chat completion. CompletableFuture<ChatCompletionDeleted>
delete(ChatCompletionDeleteParams params, RequestOptions requestOptions)
Delete a stored chat completion. -
-
Method Detail
-
withRawResponse
CompletionServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
messages
MessageServiceAsync messages()
-
create
CompletableFuture<ChatCompletion> create(ChatCompletionCreateParams params, RequestOptions requestOptions)
Creates a model response for the given chat conversation. Learn more in the text generation, vision, and audio guides.
Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.
-
createStreaming
AsyncStreamResponse<ChatCompletionChunk> createStreaming(ChatCompletionCreateParams params, RequestOptions requestOptions)
Creates a model response for the given chat conversation. Learn more in the text generation, vision, and audio guides.
Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.
-
retrieve
CompletableFuture<ChatCompletion> retrieve(ChatCompletionRetrieveParams params, RequestOptions requestOptions)
Get a stored chat completion. Only chat completions that have been created with the
store
parameter set totrue
will be returned.
-
update
CompletableFuture<ChatCompletion> update(ChatCompletionUpdateParams params, RequestOptions requestOptions)
Modify a stored chat completion. Only chat completions that have been created with the
store
parameter set totrue
can be modified. Currently, the only supported modification is to update themetadata
field.
-
delete
CompletableFuture<ChatCompletionDeleted> delete(ChatCompletionDeleteParams params, RequestOptions requestOptions)
Delete a stored chat completion. Only chat completions that have been created with the
store
parameter set totrue
can be deleted.
-
-
-
-