language-chatgpt adaptor #378
Conversation
There was a problem hiding this comment.
@haftamuk please update this to chat gpt 521x200.png
There was a problem hiding this comment.
@haftamuk please update this to chatgpt 256x256 logo
| } from '@openfn/language-common'; | ||
| import { expandReferences } from '@openfn/language-common/util'; | ||
| import { request } from './Utils'; | ||
| import 'dotenv/config'; |
There was a problem hiding this comment.
We use state.configuration for setting up credentials, please remove this library
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "properties": { | ||
| "OPENAI_SECRET_KEY": { | ||
| "title": "OPENAI_SECRET_KEY", |
| * @param {string} prompt - User textual prompt | ||
| * @returns {Operation} | ||
| */ | ||
| export function promptChatGpt(prompt) { |
There was a problem hiding this comment.
A slight suggestion on the function signature that will give users more flexibility
@param {string} prompt - User textual prompt
@param {object} options - Options for textual prompt eg model, role
ecport function promptChatGpt(prompt, options) {
return state => {
const [resolvedPrompt, resolvedOptions] = expandReferences(
state,
prompt,
options
);
//Everything else
}
}
There was a problem hiding this comment.
In addition to @mtuchi's comment (which is correct and wise), I'd like to think more about the name of this function.
We wouldn't normally include the service name in the functions - so I'd prefer prompt to promptChatGpt (it's shorter and chartGPT is implied by the adaptor package itself).
I would also question if prompt is the correct function name. I'm not an ML engineer so maybe it is. But I wonder if ask(prompt) or chat(prompt) or question(prompt) would be semantically richer and more useful alternatives? Maybe even completion(prompt), which aligns with the npm library and so I guess will be familar to openai engineers.
I welcome your thoughts on this!
| @@ -0,0 +1,104 @@ | |||
| # @openfn/language-chatgpt | |||
|
|
|||
| ## 3.0.1 | |||
There was a problem hiding this comment.
The changelog probably needs updating :)
|
Hi @haftamuk - thank you for this contribution! We're very keen to get it merged in. Are you able to respond to the feedback this week? If not, do you mind if we take it over? |
Hey. |
|
Thank you @haftamuk! We'll give you a few days and maybe take this over next week. We'll let you know if we start working on anything so that we're not duplicating effort. |
| */ | ||
| export function promptChatGpt(prompt) { | ||
| return async state => { | ||
| const openai = new OpenAI({ |
There was a problem hiding this comment.
This will create a new openai client for every prompt submitted, which presumably means context is lost in between calls.
Is this the desired behaviour? Or should we create one shared client for the job (and workflow)?
| * @param {string} prompt - User textual prompt | ||
| * @returns {Operation} | ||
| */ | ||
| export function promptChatGpt(prompt) { |
There was a problem hiding this comment.
In addition to @mtuchi's comment (which is correct and wise), I'd like to think more about the name of this function.
We wouldn't normally include the service name in the functions - so I'd prefer prompt to promptChatGpt (it's shorter and chartGPT is implied by the adaptor package itself).
I would also question if prompt is the correct function name. I'm not an ML engineer so maybe it is. But I wonder if ask(prompt) or chat(prompt) or question(prompt) would be semantically richer and more useful alternatives? Maybe even completion(prompt), which aligns with the npm library and so I guess will be familar to openai engineers.
I welcome your thoughts on this!
|
Hi @haftamuk - we'd like to merge this, make a few adjustments and put out a release. Is that OK with you? |
|
Hi @haftamuk, I am really sorry but I'm going to close this PR for now. There was a minute there when we were going to take it over and release it ourselves. But we missed that boat and we've got other priorities at the moment. I'd welcome a new PR which addresses the comments above and updates the library version. But until then the PR must be closed 🙏 |
Summary
language-chatgpt adaptor added
Details
A promptChatGpt(prompt) function is created to interact with OpenAI gpt-3.5-turbo model.
Issues
API Reference
Review Checklist
Before merging, the reviewer should check the following items:
migration guide followed?
dev only changes don't need a changeset.