adding model list examples to api reference

predictionguard · Jul 23, 2024 · c3454f0 · c3454f0
1 parent 3aa4837
commit c3454f0
Showing 1 changed file with 53 additions and 0 deletions.
diff --git a/fern/openapi/Prediction-Guard-Prediction-Guard-API-1.0-resolved.yaml b/fern/openapi/Prediction-Guard-Prediction-Guard-API-1.0-resolved.yaml
@@ -208,6 +208,25 @@ paths:
               }
       security:
         - ApiKeyCredentials: []
+    get:
+      summary: List Chat Models
+      description: A simple endpoint to check what models are available in the /chat/completions endpoint.
+      responses:
+        '200':
+          description: Successful response with an array of LLMs.
+          content:
+            text/plain:
+              schema:
+                type: string
+              example: |
+                [
+                  "Hermes-2-Pro-Mistral-7B",
+                  "Neural-Chat-7B",
+                  "llama-3-sqlcoder-8b",
+                  "deepseek-coder-6.7b-instruct",
+                  "Hermes-2-Pro-Llama-3-8B",
+                  "llava-1.5-7b-hf"
+                ]
 
   /chat/completions - Streaming Version:
     post:
@@ -774,6 +793,25 @@ paths:
               }
       security:
         - ApiKeyCredentials: []
+    get:
+      summary: List Completions Models
+      description: A simple endpoint to check what models are available in the /completions endpoint.
+      responses:
+        '200':
+          description: Successful response with an array of LLMs.
+          content:
+            text/plain:
+              schema:
+                type: string
+              example: |
+                [
+                  "Hermes-2-Pro-Mistral-7B",
+                  "Nous-Hermes-Llama2-13B",
+                  "Neural-Chat-7B",
+                  "llama-3-sqlcoder-8b",
+                  "deepseek-coder-6.7b-instruct",
+                  "Hermes-2-Pro-Llama-3-8B"
+                ]
 
   /embedding:
     post:
@@ -894,6 +932,21 @@ paths:
       security:
         - ApiKeyCredentials: []
 
+    get:
+      summary: List Embeddings Models
+      description: A simple endpoint to check what models are available in the /embeddings endpoint.
+      responses:
+        '200':
+          description: Successful response with an array of embeddings generation models.
+          content:
+            text/plain:
+              schema:
+                type: string
+              example: |
+                [
+                  "bridgetower-large-itm-mlm-itc"
+                ]
+
   /factuality:
     post:
       summary: Factuality