Update model description (#103)

Update model description
langchain-ai · Mar 22, 2024 · dd3076a · dd3076a
1 parent 4b14415
commit dd3076a
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/backend/server/api/configurables.py b/backend/server/api/configurables.py
@@ -23,13 +23,21 @@ class ConfigurationResponse(TypedDict):
     max_file_size_mb: int
     max_concurrency: int
     max_chunks: int
+    models: List[dict]
 
 
 @router.get("")
 def get() -> ConfigurationResponse:
     """Endpoint to show server configuration."""
     return {
-        "available_models": sorted(SUPPORTED_MODELS),
+        "available_models": sorted(SUPPORTED_MODELS),  # Deprecate
+        "models": [
+            {
+                "name": model,
+                "description": data["description"],
+            }
+            for model, data in SUPPORTED_MODELS.items()
+        ],
         "accepted_mimetypes": SUPPORTED_MIMETYPES,
         "max_file_size_mb": MAX_FILE_SIZE_MB,
         "max_concurrency": MAX_CONCURRENCY,

diff --git a/backend/tests/unit_tests/api/test_api_configuration.py b/backend/tests/unit_tests/api/test_api_configuration.py
@@ -14,6 +14,7 @@ async def test_configuration_api() -> None:
             "max_chunks",
             "max_concurrency",
             "max_file_size_mb",
+            "models",
         ]
         models = result["available_models"]
         assert all(isinstance(model_name, str) for model_name in models)

diff --git a/frontend/app/components/Playground.tsx b/frontend/app/components/Playground.tsx
@@ -116,12 +116,12 @@ export const Playground = (props: PlaygroundProps) => {
               <FormLabel as="legend">Extraction Model</FormLabel>
               <RadioGroup
                 name="modelId"
-                defaultValue={requestServerConfig.data?.available_models[0]}
+                defaultValue={requestServerConfig.data?.models[0].name}
               >
                 <HStack spacing="24px">
-                  {requestServerConfig.data?.available_models.map((model) => (
-                    <Radio value={model} key={model}>
-                      {model}
+                  {requestServerConfig.data?.models.map((model) => (
+                    <Radio value={model.name} key={model.name}>
+                      {model.description}
                     </Radio>
                   ))}
                 </HStack>

diff --git a/frontend/app/utils/api.tsx b/frontend/app/utils/api.tsx
@@ -74,10 +74,15 @@ const createExtractor: MutationFunction<any, any> = async (extractor) => {
   return response.data;
 };
 
+export type Model = {
+  name: string;
+  description: string;
+};
+
 export type ServerConfiguration = {
-  available_models: string[];
   max_file_size_mb: number;
   accepted_mimetypes: string[];
+  models: Model[];
 };
 
 const getConfiguration = async (): Promise<ServerConfiguration> => {