Constructor Detail

Method Detail

• messages

   abstract MessageServiceAsync messages()

• create

   abstract 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.

• create

   abstract CompletableFuture<ChatCompletion> create(ChatCompletionCreateParams params)

  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

   abstract 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.

• createStreaming

   abstract AsyncStreamResponse<ChatCompletionChunk> createStreaming(ChatCompletionCreateParams params)

  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

   abstract CompletableFuture<ChatCompletion> retrieve(ChatCompletionRetrieveParams params, RequestOptions requestOptions)

  Get a stored chat completion. Only chat completions that have been created with the store parameter set to true will be returned.

• retrieve

   abstract CompletableFuture<ChatCompletion> retrieve(ChatCompletionRetrieveParams params)

  Get a stored chat completion. Only chat completions that have been created with the store parameter set to true will be returned.

• update

   abstract CompletableFuture<ChatCompletion> update(ChatCompletionUpdateParams params, RequestOptions requestOptions)

  Modify a stored chat completion. Only chat completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

• update

   abstract CompletableFuture<ChatCompletion> update(ChatCompletionUpdateParams params)

  Modify a stored chat completion. Only chat completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

• delete

   abstract CompletableFuture<ChatCompletionDeleted> delete(ChatCompletionDeleteParams params, RequestOptions requestOptions)

  Delete a stored chat completion. Only chat completions that have been created with the store parameter set to true can be deleted.

• delete

   abstract CompletableFuture<ChatCompletionDeleted> delete(ChatCompletionDeleteParams params)

  Delete a stored chat completion. Only chat completions that have been created with the store parameter set to true can be deleted.