Skip to content

Commit

Permalink
Update doc/functions/openAIChat.md
Browse files Browse the repository at this point in the history
I know why those happened, and can avoid them in the future!

In MLX files, you can create hyperlinks which link to lines in the same file. I tried to see whether this would translate into the markdown - turns out it hasn't. What it has done is taken those hyperlinks and just given them extra backticks with no functionality. So long as I stop trying to link between passages, this should not be an issue.

Co-authored-by: Christopher Creutzig <[email protected]>
  • Loading branch information
MiriamScharnke and ccreutzi authored Jul 29, 2024
1 parent 19c70ee commit 56a65e7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/functions/openAIChat.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To connect to the OpenAI API, you need a valid API key. For information on how t
`chat = openAIChat` creates an `openAIChat` object. Connecting to the OpenAI API requires a valid API key. Either set the environment variable `OPENAI_API_KEY` or specify the `APIKey` name\-value argument.


`chat = openAIChat(``systemPrompt``)` creates an `openAIChat` object with the specified system prompt.
`chat = openAIChat(systemPrompt)` creates an `openAIChat` object with the specified system prompt.


`chat = openAIChat(___,APIKey=key)` uses the specified API key.
Expand Down

0 comments on commit 56a65e7

Please sign in to comment.