From 7d8290f58616285b6cb5b11fb75ac416eabb2680 Mon Sep 17 00:00:00 2001 From: John Alling <44934218+jalling97@users.noreply.github.com> Date: Fri, 4 Oct 2024 10:57:52 -0400 Subject: [PATCH] Create dev_guide.md --- .../en/docs/dev-with-lfai-guide/dev_guide.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 website/content/en/docs/dev-with-lfai-guide/dev_guide.md diff --git a/website/content/en/docs/dev-with-lfai-guide/dev_guide.md b/website/content/en/docs/dev-with-lfai-guide/dev_guide.md new file mode 100644 index 000000000..8de5a9972 --- /dev/null +++ b/website/content/en/docs/dev-with-lfai-guide/dev_guide.md @@ -0,0 +1,23 @@ +--- +title: App Development using LeapfrogAI +type: docs +weight: 1 +--- + +Prior to developing applications using LeapfrogAI, ensure that you have a valid instance of LeapfrogAI deployed in your environment. See the [Quick Start](https://docs.leapfrog.ai/docs/local-deploy-guide/quick_start/) page for more info on how to get started. + +## OpenAI Compatibility in LeapfrogAI + +The LeapfrogAI API is an OpenAI-compatible API, meaning that the endpoints built out within the LeapfrogAI API as what is found within the OpenAI API. **Note:** Not all endpoints/functionality in OpenAI is implemented in LeapfrogAI. To see what endpoints are implemented in your deployment, reference the [Quick Start](https://docs.leapfrog.ai/docs/local-deploy-guide/quick_start/#checking-deployment) guide for how to check the API reference. + +## Using the OpenAI SDK with LeapfrogAI + +### OpenAI API Refernce + +### Creating the Client + +### Running Chat Completions + +### Building a RAG Pipeline using Assistants + +## Questions/Feedback