Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correction: #4

Closed
2 tasks done
Snarik opened this issue May 11, 2023 · 3 comments
Closed
2 tasks done

Correction: #4

Snarik opened this issue May 11, 2023 · 3 comments
Assignees
Labels
correction Correction, grammatical or other details. NOT out-of-date information

Comments

@Snarik
Copy link

Snarik commented May 11, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Section for Correction

Chat API flow.

Correction

I'm not in the mood to create a fork of this repo, and you've disabled branches/PRs the way normal public repos do things, but here's some additional color to explain to your users how the endpoints work.

In the README.md at line 269 I recommend adding the following information:

This request begins it's life as an a POST request, but is transitioned to an EventStream-- most likely with a library like [fetch-event-source](https://github.com/Azure/fetch-event-source.).
Data is streamed from the `/conversation` endpoint until some done state is achieved, at which point the SSE connection closes. 
The data that came off the event listener is set as a local state in the UI and is subsequently passed to the moderations endpoint for approval. 

CONTRIBUTING.md

  • I have read the CONTRIBUTING.md
@Snarik Snarik added the correction Correction, grammatical or other details. NOT out-of-date information label May 11, 2023
@Snarik
Copy link
Author

Snarik commented May 11, 2023

I would also update line 253, removing the parenthetical that there is no response, as there is one-- it's just ephemeral.

Copy link
Owner

Thanks for the correction! I'll add this to the repo soon.

@terminalcommandnewsletter
Copy link
Owner

I've added the response of the /backend-api/conversation API to the repo as per this issue.

https://github.com/terminalcommandnewsletter/everything-chatgpt/blob/main/README.md?plain=1#L253-L272

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction Correction, grammatical or other details. NOT out-of-date information
Projects
None yet
Development

No branches or pull requests

2 participants