All Implemented Interfaces:
```
public interface ChatCompletionService

                    
```
Given a list of messages comprising a conversation, the model will return a response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ChatCompletionService.WithRawResponse`	A view of ChatCompletionService that provides access to raw HTTP responses for each method.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract ChatCompletionService.WithRawResponse`	`withRawResponse()`	Returns a view of this service that provides access to raw HTTP responses for each method.
`abstract ChatCompletionService`	`withOptions(Consumer<ClientOptions.Builder> modifier)`	Returns a view of this service with the given option modifications applied.
`abstract MessageService`	`messages()`	Given a list of messages comprising a conversation, the model will return a response.
`ChatCompletion`	`create(ChatCompletionCreateParams params)`	Starting a new project?
`abstract ChatCompletion`	`create(ChatCompletionCreateParams params, RequestOptions requestOptions)`
`<T extends Any> StructuredChatCompletion<T>`	`create(StructuredChatCompletionCreateParams<T> params)`	Creates a model response for the given chat conversation.
`<T extends Any> StructuredChatCompletion<T>`	`create(StructuredChatCompletionCreateParams<T> params, RequestOptions requestOptions)`	Creates a model response for the given chat conversation.
`StreamResponse<ChatCompletionChunk>`	`createStreaming(ChatCompletionCreateParams params)`	Starting a new project?
`abstract StreamResponse<ChatCompletionChunk>`	`createStreaming(ChatCompletionCreateParams params, RequestOptions requestOptions)`
`StreamResponse<ChatCompletionChunk>`	`createStreaming(StructuredChatCompletionCreateParams<?> params)`	Creates a streaming model response for the given chat conversation.
`StreamResponse<ChatCompletionChunk>`	`createStreaming(StructuredChatCompletionCreateParams<?> params, RequestOptions requestOptions)`
`ChatCompletion`	`retrieve(String completionId)`	Get a stored chat completion.
`ChatCompletion`	`retrieve(String completionId, ChatCompletionRetrieveParams params, RequestOptions requestOptions)`
`ChatCompletion`	`retrieve(String completionId, ChatCompletionRetrieveParams params)`
`abstract ChatCompletion`	`retrieve(ChatCompletionRetrieveParams params, RequestOptions requestOptions)`
`ChatCompletion`	`retrieve(ChatCompletionRetrieveParams params)`
`ChatCompletion`	`retrieve(String completionId, RequestOptions requestOptions)`
`ChatCompletion`	`update(String completionId, ChatCompletionUpdateParams params)`	Modify a stored chat completion.
`ChatCompletion`	`update(String completionId, ChatCompletionUpdateParams params, RequestOptions requestOptions)`
`ChatCompletion`	`update(ChatCompletionUpdateParams params)`
`abstract ChatCompletion`	`update(ChatCompletionUpdateParams params, RequestOptions requestOptions)`
`ChatCompletionListPage`	`list()`	List stored Chat Completions.
`abstract ChatCompletionListPage`	`list(ChatCompletionListParams params, RequestOptions requestOptions)`
`ChatCompletionListPage`	`list(ChatCompletionListParams params)`
`ChatCompletionListPage`	`list(RequestOptions requestOptions)`
`ChatCompletionDeleted`	`delete(String completionId)`	Delete a stored chat completion.
`ChatCompletionDeleted`	`delete(String completionId, ChatCompletionDeleteParams params, RequestOptions requestOptions)`
`ChatCompletionDeleted`	`delete(String completionId, ChatCompletionDeleteParams params)`
`abstract ChatCompletionDeleted`	`delete(ChatCompletionDeleteParams params, RequestOptions requestOptions)`
`ChatCompletionDeleted`	`delete(ChatCompletionDeleteParams params)`
`ChatCompletionDeleted`	`delete(String completionId, RequestOptions requestOptions)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - withRawResponse
```
 abstract ChatCompletionService.WithRawResponse withRawResponse()
```
    Returns a view of this service that provides access to raw HTTP responses for each method.
  - withOptions
```
 abstract ChatCompletionService withOptions(Consumer<ClientOptions.Builder> modifier)
```
    Returns a view of this service with the given option modifications applied.
    The original service is not modified.
  - messages
```
 abstract MessageService messages()
```
    Given a list of messages comprising a conversation, the model will return a response.
  - create
```
 ChatCompletion create(ChatCompletionCreateParams params)
```
    Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses.
    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.
    Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.
  - create
```
 abstract ChatCompletion create(ChatCompletionCreateParams params, RequestOptions requestOptions)
```
  - create
```
 <T extends Any> StructuredChatCompletion<T> create(StructuredChatCompletionCreateParams<T> params)
```
    Creates a model response for the given chat conversation. The model's structured output in JSON form will be deserialized automatically into an instance of the class T. See the SDK documentation for more details.
  - create
```
 <T extends Any> StructuredChatCompletion<T> create(StructuredChatCompletionCreateParams<T> params, RequestOptions requestOptions)
```
    Creates a model response for the given chat conversation. The model's structured output in JSON form will be deserialized automatically into an instance of the class T. See the SDK documentation for more details.
  - createStreaming
```
@MustBeClosed() StreamResponse<ChatCompletionChunk> createStreaming(ChatCompletionCreateParams params)
```
    Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses.
    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.
    Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.
  - createStreaming
```
@MustBeClosed() abstract StreamResponse<ChatCompletionChunk> createStreaming(ChatCompletionCreateParams params, RequestOptions requestOptions)
```
  - createStreaming
```
@MustBeClosed() StreamResponse<ChatCompletionChunk> createStreaming(StructuredChatCompletionCreateParams<?> params)
```
    Creates a streaming model response for the given chat conversation. The input parameters can define a JSON schema derived automatically from an arbitrary class to request a structured output in JSON form. However, that structured output is split over multiple streamed events, so it will not be deserialized automatically into an instance of that class. To deserialize the output, first use a helper class to accumulate the stream of events into a single output value. See the SDK documentation for full details.
  - createStreaming
```
@MustBeClosed() StreamResponse<ChatCompletionChunk> createStreaming(StructuredChatCompletionCreateParams<?> params, RequestOptions requestOptions)
```
  - retrieve
```
 ChatCompletion retrieve(String completionId)
```
    Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.
  - retrieve
```
 ChatCompletion retrieve(String completionId, ChatCompletionRetrieveParams params, RequestOptions requestOptions)
```
  - retrieve
```
 ChatCompletion retrieve(String completionId, ChatCompletionRetrieveParams params)
```
  - retrieve
```
 abstract ChatCompletion retrieve(ChatCompletionRetrieveParams params, RequestOptions requestOptions)
```
  - retrieve
```
 ChatCompletion retrieve(ChatCompletionRetrieveParams params)
```
  - retrieve
```
 ChatCompletion retrieve(String completionId, RequestOptions requestOptions)
```
  - update
```
 ChatCompletion update(String completionId, 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.
  - update
```
 ChatCompletion update(String completionId, ChatCompletionUpdateParams params, RequestOptions requestOptions)
```
  - update
```
 ChatCompletion update(ChatCompletionUpdateParams params)
```
  - update
```
 abstract ChatCompletion update(ChatCompletionUpdateParams params, RequestOptions requestOptions)
```
  - list
```
 ChatCompletionListPage list()
```
    List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.
  - list
```
 abstract ChatCompletionListPage list(ChatCompletionListParams params, RequestOptions requestOptions)
```
  - list
```
 ChatCompletionListPage list(ChatCompletionListParams params)
```
  - list
```
 ChatCompletionListPage list(RequestOptions requestOptions)
```
  - delete
```
 ChatCompletionDeleted delete(String completionId)
```
    Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.
  - delete
```
 ChatCompletionDeleted delete(String completionId, ChatCompletionDeleteParams params, RequestOptions requestOptions)
```
  - delete
```
 ChatCompletionDeleted delete(String completionId, ChatCompletionDeleteParams params)
```
  - delete
```
 abstract ChatCompletionDeleted delete(ChatCompletionDeleteParams params, RequestOptions requestOptions)
```
  - delete
```
 ChatCompletionDeleted delete(ChatCompletionDeleteParams params)
```
  - delete
```
 ChatCompletionDeleted delete(String completionId, RequestOptions requestOptions)
```

Interface ChatCompletionService

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

withRawResponse

withOptions

messages

create

create

create

create

createStreaming

createStreaming

createStreaming

createStreaming

retrieve

retrieve

retrieve

retrieve

retrieve

retrieve

update

update

update

update

list

list

list

list

delete

delete

delete

delete

delete

delete