Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

Create docs showing how to interact with the api

Open andrewm4894 opened this issue 2 years ago • 9 comments

Create some docs showing examples of how to interact and use the api.

Maybe also or instead could just be a notebook too.

Should be a good first issue for someone.

I'm happy to help anyone if needed.

andrewm4894 avatar Feb 11 '23 08:02 andrewm4894

https://projects.laion.ai/Open-Assistant/api there are docs but there isn't a way to get an valid api key

mrloldev avatar Feb 11 '23 19:02 mrloldev

@andrewm4894 is this issue open for contribution ?

remote007 avatar Feb 21 '23 13:02 remote007

@andrewm4894 I'm interested in taking this one too

jsugg avatar May 29 '23 23:05 jsugg

Totally, feel free to work away. It could be a notebook maybe or just some section of /docs

So we could take like an interactive notebook approach like here

https://github.com/LAION-AI/Open-Assistant/tree/main/notebooks/openassistant-oasst1

Or just add some tutorials in here

https://github.com/LAION-AI/Open-Assistant/tree/main/docs/docs/api

Or another approach could be a blog post in here

https://github.com/LAION-AI/Open-Assistant/tree/main/docs/blog

Or some combination of all this.

Maybe a tutorial sort of blog approach could be a good way to start, could be nice.

andrewm4894 avatar May 30 '23 07:05 andrewm4894

@jsugg can i pitch in. I'm looking for an issue to take up and this is very interesting

drShivashankar avatar Aug 10 '23 08:08 drShivashankar

@jsugg can i pitch in. I'm looking for an issue to take up and this is very interesting

I'm working in another issue right now, so please go ahead!

jsugg avatar Aug 10 '23 18:08 jsugg

Thank you. Please give some insights if any. helps headstart

drShivashankar avatar Aug 10 '23 19:08 drShivashankar

Thank you. Please give some insights if any. helps headstart

I'd be glad to, but I have none bud. Good luck!

jsugg avatar Aug 11 '23 05:08 jsugg

@andrewm4894 I want understand the setup. who would be the target audience for this (anybody or ppl who deploy locally on their machines or for the "API" page of open-assistant webpage (helps me decide where to start)

drShivashankar avatar Aug 13 '23 19:08 drShivashankar