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

[task] Documentation Aware Assistance #19

Open
jon-tow opened this issue Nov 8, 2022 · 1 comment
Open

[task] Documentation Aware Assistance #19

jon-tow opened this issue Nov 8, 2022 · 1 comment
Labels
task New instruction task

Comments

@jon-tow
Copy link
Collaborator

jon-tow commented Nov 8, 2022

🚀 The Task

If a user is using an AI pair programmer to work with a custom library or framework, performance will be much better if the prompt includes some documentation of the library or some examples of usage. The model should be able to utilize this context effectively.

Example

Help me write a chatbot using the OpenAI Completions API. Here is their API documentation:
  
  [Create completion](https://beta.openai.com/docs/api-reference/completions/create)
  POST
   
  https://api.openai.com/v1/completions
  
  Creates a completion for the provided prompt and parameters
  
  ==== 
  
  Request body
  
    model: string (Required)
      ID of the model to use. You can use the [List models](https://beta.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://beta.openai.com/docs/models/overview) for descriptions of them.
  ...

Additional Notes

@jon-tow jon-tow added the task New instruction task label Nov 9, 2022
@jon-tow
Copy link
Collaborator Author

jon-tow commented Nov 12, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task New instruction task
Projects
None yet
Development

No branches or pull requests

1 participant