Package com.openai.services.blocking
        Interface ImageService
- 
                    
                    
- All Implemented Interfaces:
 
public interface ImageService 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceImageService.WithRawResponseA view of ImageService that provides access to raw HTTP responses for each method.
 
- 
                                
                            
                                
Method Summary
Modifier and Type Method Description abstract ImageService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract ImageServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. ImagesResponsecreateVariation(ImageCreateVariationParams params)Creates a variation of a given image. abstract ImagesResponsecreateVariation(ImageCreateVariationParams params, RequestOptions requestOptions)ImagesResponseedit(ImageEditParams params)Creates an edited or extended image given one or more source images and a prompt. abstract ImagesResponseedit(ImageEditParams params, RequestOptions requestOptions)StreamResponse<ImageEditStreamEvent>editStreaming(ImageEditParams params)Creates an edited or extended image given one or more source images and a prompt. abstract StreamResponse<ImageEditStreamEvent>editStreaming(ImageEditParams params, RequestOptions requestOptions)ImagesResponsegenerate(ImageGenerateParams params)Creates an image given a prompt. abstract ImagesResponsegenerate(ImageGenerateParams params, RequestOptions requestOptions)StreamResponse<ImageGenStreamEvent>generateStreaming(ImageGenerateParams params)Creates an image given a prompt. abstract StreamResponse<ImageGenStreamEvent>generateStreaming(ImageGenerateParams params, RequestOptions requestOptions)- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
withRawResponse
abstract ImageService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
 
- 
                                        
withOptions
abstract ImageService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
 
- 
                                        
createVariation
ImagesResponse createVariation(ImageCreateVariationParams params)
Creates a variation of a given image. This endpoint only supports
dall-e-2. 
- 
                                        
createVariation
abstract ImagesResponse createVariation(ImageCreateVariationParams params, RequestOptions requestOptions)
 
- 
                                        
edit
ImagesResponse edit(ImageEditParams params)
Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports
gpt-image-1anddall-e-2. 
- 
                                        
edit
abstract ImagesResponse edit(ImageEditParams params, RequestOptions requestOptions)
 
- 
                                        
editStreaming
@MustBeClosed() StreamResponse<ImageEditStreamEvent> editStreaming(ImageEditParams params)
Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports
gpt-image-1anddall-e-2. 
- 
                                        
editStreaming
@MustBeClosed() abstract StreamResponse<ImageEditStreamEvent> editStreaming(ImageEditParams params, RequestOptions requestOptions)
 
- 
                                        
generate
ImagesResponse generate(ImageGenerateParams params)
Creates an image given a prompt. Learn more.
 
- 
                                        
generate
abstract ImagesResponse generate(ImageGenerateParams params, RequestOptions requestOptions)
 
- 
                                        
generateStreaming
@MustBeClosed() StreamResponse<ImageGenStreamEvent> generateStreaming(ImageGenerateParams params)
Creates an image given a prompt. Learn more.
 
- 
                                        
generateStreaming
@MustBeClosed() abstract StreamResponse<ImageGenStreamEvent> generateStreaming(ImageGenerateParams params, RequestOptions requestOptions)
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -