jevinjiang commented on code in PR #215: URL: https://github.com/apache/eventmesh-site/pull/215#discussion_r1572680777
########## docs/design-document/03-connect/12-chatgpt-connector.md: ########## @@ -0,0 +1,123 @@ +# ChatGPT + +## ChatGPT Source Connector + +### Configuration + +Before using ChatGPT source connector, you need to configure the server. +- Please configure `sourceEnable` to `true` in `/resource/server-config.yml` to enable source functionality. +- Please configure the source connector in `/resource/source-config.yml`: + - `connectorConfig` + - `connectorName`, name of the connector. + - (required) `path`, path of the API. + - (required) `port`, port of the API. + - `idleTimeout`, idle TCP connection timeout in seconds. A connection will timeout and be closed if no data is received nor sent within the `idleTimeout` seconds. The default is 0, which means don't timeout. + - `proxyEnable`, Proxy switch for openai request, default false. + - `parsePromptFileName`, parse prompt template required by the user to use the parse request, default to the "prompt" file in the resource folder. + - `openaiConfig` + - (required) `token`, token of the openai + - (required) `model`, model of the openai + - `timeout`, openai connection timeout in seconds. + - `temperature`, https://platform.openai.com/docs/api-reference/chat/create `temperature`. + - `maxTokens`, https://platform.openai.com/docs/api-reference/chat/create `max_tokens`. + - `frequencyPenalty`, https://platform.openai.com/docs/api-reference/chat/create `presence_penalty`. + - `user`, https://platform.openai.com/docs/api-reference/chat/create `user`. + - `stop`, https://platform.openai.com/docs/api-reference/chat/create `stop`. + - `logitBias`, https://platform.openai.com/docs/api-reference/chat/create `logit_bias`. + - `openaiProxyConfig`, If `connectorConfig. proxyEnable` is true, then this configuration is required + - `host`, host of the openai proxy + - `port`, port of the openai proxy + +### Startup + +1. start EventMesh Runtime +2. start eventmesh-connector-chatgpt + +When finished, the ChatGPT source connector will act as an HTTP server. + +### Sending messages + +You can send messages to the source connector via HTTP. + +```yaml +connectorConfig: + connectorName: chatgptSource + path: /chatgpt + port: 3756 + idleTimeout: 30 + proxyEnable: false + parsePromptFileName: prompt +openaiConfig: + token: + model: gpt-3.5-turbo + timeout: 30 + temperature: 1 + maxTokens: + frequencyPenalty: 0 + presencePenalty: 0 + user: eventMesh + stop: [] + logitBias: {} + +openaiProxyConfig: + host: 127.0.0.1 + port: 7890 +``` + +The above example configures a URL `http://localhost:3756/chatgpt` in `source-config.yml`. + +You can send messages in `CHAT` or `PARSE` request type, default `CHAT`, + +### CHAT + +the request type of "CHAT" is a conversation with ChatGPT + +example: +```shell +curl --location --request POST 'http://localhost:3756/chatgpt' \ +--data-raw '{ + "requestType": "CHAR", + "type": "com.example.someevent", + "source": "/mycontext", + "subject":"test_topic", + "datacontenttype":"text/plain", + "text": "you want to talk to ChatGPT about " +}' +``` + +### PARSE + +the request type of "PARSE" is a output parse. +ChatGPT will parse the output into a result set of type "datacontenttype" and put it into the data of cloudevent + +example: +```shell +curl --location --request POST 'http://localhost:3756/chatgpt' \ +--data-raw '{ + "requestType": "PARSE", + "type": "com.example.someevent", + "source": "/mycontext", + "subject":"test_topic", + "datacontenttype":"application/json", + "text": "This leaf blower is pretty amazing. It has four settings: candle blower, gentle breeze, windy city, and tornado. It arrived in two days, just in time for my wife's anniversary present. I think my wife liked it so much she was speechless. So far I've been the only one using it, and I've been using it every other morning to clear the leaves on our lawn. It's slightly more expensive than the other leaf blowers out there, but I think it's worth it for the extra features.", + "fields": "gift:Was the item purchased as a gift for someone else? Answer True if yes, False if not or unknown;delivery_days:How many days did it take for the product to arrive? If this information is not found, output -1;price_value:Extract any sentences about the value or price, and output them as a comma separated Python list" +}' +``` +if `datacontenttype` is `application/json`, `cloudevent.data` is: Review Comment: good idea~ , yours is better -- 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...@eventmesh.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@eventmesh.apache.org For additional commands, e-mail: issues-h...@eventmesh.apache.org
