microsoft / TypeChat

TypeChat is a library that makes it easy to build natural language interfaces using types.
https://microsoft.github.io/TypeChat/
MIT License
8.24k stars 391 forks source link

Full prompt for a specific task #87

Open chllei opened 1 year ago

chllei commented 1 year ago

Thank you so much for developing such a useful tool. I usually only use Python and other mathematical software, and I am not familiar with TypeScript. I don't know from this library how to give a complete prompt for a specific problem. Can you add a description to the documentation? For example, what is the full prompt for the sentiment task?

DanielRosenwasser commented 1 year ago

Hey there! Hopefully we can provide a more Python-like experience in the future. There's a README in the sentiment example which points out that input.txt has a few examples of inputs for the prompt.

A translator object will construct a prompt using a set of TypeScript types, a specific type for the response, and whatever user input was provided.

I'm also developing some documentation around using TypeChat over at https://github.com/microsoft/TypeChat/pull/65.

Does that answer your question? Is there something that would make some of this more obvious?

chllei commented 1 year ago

Hey there! Hopefully we can provide a more Python-like experience in the future. There's a README in the sentiment example which points out that input.txt has a few examples of inputs for the prompt.

A translator object will construct a prompt using a set of TypeScript types, a specific type for the response, and whatever user input was provided.

I'm also developing some documentation around using TypeChat over at #65.

Does that answer your question? Is there something that would make some of this more obvious?

Thank you very much for your reply, which gave me some insight into the code structure. I'll try it myself.