OpenAiCompatibleModelClient (flink-cdc-parent 3.8-SNAPSHOT API)

java.lang.Object
- org.apache.flink.cdc.models.openai.OpenAiCompatibleModelClient

All Implemented Interfaces:

Serializable, AutoCloseable, SupportsEmbedding, SupportsImageTextGeneration, SupportsTextGeneration, AiModelClient
```
public class OpenAiCompatibleModelClient
extends Object
implements AiModelClient, SupportsTextGeneration, SupportsEmbedding, SupportsImageTextGeneration
```
AI model client that connects to an OpenAI-compatible endpoint.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`float[]`	`embed(String text)`	Converts the given text into a dense float vector.
`String`	`generate(String systemPrompt, String userInput)`	Generates text based on a system-level prompt and a user-provided input message.
`String`	`generateTextFromImage(byte[] image, String prompt)`	Generates text from the given image bytes guided by a natural-language prompt.
`void`	`open()`

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

- Method Detail
  - open
```
public void open()
```
    Specified by:
    
    open in interface AiModelClient
  - close
```
public void close()
```
    Specified by:
    
    close in interface AiModelClient
    
    Specified by:
    
    close in interface AutoCloseable
  - generate
```
public String generate(String systemPrompt,
                       String userInput)
```
    Description copied from interface: SupportsTextGeneration
    
    Generates text based on a system-level prompt and a user-provided input message. Returns a JSON string conforming to the output schema declared by the calling AI function.
    
    Specified by:
    
    generate in interface SupportsTextGeneration
  - embed
```
public float[] embed(String text)
```
    Description copied from interface: SupportsEmbedding
    
    Converts the given text into a dense float vector.
    
    Specified by:
    
    embed in interface SupportsEmbedding
  - generateTextFromImage
```
public String generateTextFromImage(byte[] image,
                                    String prompt)
```
    Description copied from interface: SupportsImageTextGeneration
    
    Generates text from the given image bytes guided by a natural-language prompt.
    
    Specified by:
    
    generateTextFromImage in interface SupportsImageTextGeneration