[FLINK-37799][model][docs] Add document for OpenAI Model Function #26671
Conversation
|
|
||
| # OpenAI | ||
|
|
||
| The OpenAI Model Function allows Flink SQL to call OpenAI API for inference tasks. |
There was a problem hiding this comment.
I suggest a link to the OpenAI javadoc on the words OpenAI API
There was a problem hiding this comment.
Thanks for the comment! I've add the link.
|
|
||
| The function supports calling remote OpenAI model services via Flink SQL for prediction/inference tasks. Currently, the following tasks are supported: | ||
|
|
||
| * chat completions |
There was a problem hiding this comment.
I think there needs to be more information about these 2 tasks, and why we are restricted to these tasks?
It would be good to include links to what these mean,
https://platform.openai.com/docs/api-reference/chat
https://platform.openai.com/docs/api-reference/embeddings
|
|
||
| ## Usage examples | ||
|
|
||
| The following example creates a chat completions model and use it to predict sentiment labels for movie reviews. |
| WITH ( | ||
| 'provider'='openai', | ||
| 'endpoint'='https://api.openai.com/v1/chat/completions', | ||
| 'api-key' = '<YOUR KEY>', |
There was a problem hiding this comment.
I suggest we define <YOUR KEY>.
| <td>required</td> | ||
| <td style="word-wrap: break-word;">(none)</td> | ||
| <td>String</td> | ||
| <td>Full URL of the OpenAI API endpoint, e.g., <code>https://api.openai.com/v1/chat/completions</code> or |
| </tbody> | ||
| </table> | ||
|
|
||
| ### chat/completions |
There was a problem hiding this comment.
chat/completions is different to chat completions that we mentioned earlier as a task. I suggest being consistent.
| <td>optional</td> | ||
| <td style="word-wrap: break-word;">"You are a helpful assistant."</td> | ||
| <td>String</td> | ||
| <td>System message for chat tasks.</td> |
There was a problem hiding this comment.
It would be useful to point into the OpenAI docs as to what this and the other parameters mean. I notice we use the phrase system-prompt an System message, I suggest we define one and point to it an only use one way to refer to this. When we say system here - do we mean system role?
What is the purpose of the change
This PR is a continuation to #26652, adding document for the introduced OpenAI Model Function.
Brief change log
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation