yunfengzhou-hub commented on code in PR #26671: URL: https://github.com/apache/flink/pull/26671#discussion_r2156234871
########## docs/content/docs/connectors/models/openai.md: ########## @@ -0,0 +1,244 @@ +--- +title: "OpenAI" +weight: 1 +type: docs +--- +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# OpenAI + +The OpenAI Model Function allows Flink SQL to call [OpenAI API](https://platform.openai.com/docs/overview) for inference tasks. + +## Overview + +The function supports calling remote OpenAI model services via Flink SQL for prediction/inference tasks. Currently, the following tasks are supported: + +* chat completions +* embeddings + +## Usage examples + +The following example creates a chat completions model and use it to predict sentiment labels for movie reviews. + +First, create the chat completions model with the following SQL statement: + +```sql +CREATE MODEL ai_analyze_sentiment +INPUT (`input` STRING) +OUTPUT (`content` STRING) +WITH ( + 'provider'='openai', + 'endpoint'='https://api.openai.com/v1/chat/completions', + 'api-key' = '<YOUR KEY>', Review Comment: I'm not sure about what it means to "define" \<YOUR KEY\>. Do you mean we should somehow define a variable or constant in this markdown document? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
