Adds provision for provider to have help when no model list exists

packages/jupyter-ai-magics/jupyter_ai_magics/magics.py

@@ -146,7 +146,10 @@ def __init__(self, shell):
     def _ai_bulleted_list_models_for_provider(self, provider_id, Provider):
         output = ""
         if len(Provider.models) == 1 and Provider.models[0] == "*":
-            output += f"* {PROVIDER_NO_MODELS}\n"
+            if Provider.model_help is None:
+                output += f"* {PROVIDER_NO_MODELS}\n"
+            else:
+                output += f"* {Provider.model_help}\n"
         else:
             for model_id in Provider.models:
                 output += f"* {provider_id}:{model_id}\n"
@@ -158,7 +161,10 @@ def _ai_inline_list_models_for_provider(self, provider_id, Provider):
         output = ""
 
         if len(Provider.models) == 1 and Provider.models[0] == "*":
-            return PROVIDER_NO_MODELS
+            if Provider.model_help is None:
+                return PROVIDER_NO_MODELS
+            else:
+                return Provider.model_help
 
         for model_id in Provider.models:
             output += f", `{provider_id}:{model_id}`"

packages/jupyter-ai-magics/jupyter_ai_magics/providers.py

@@ -86,6 +86,10 @@ class Config:
     """List of supported models by their IDs. For registry providers, this will
     be just ["*"]."""
 
+    model_help: ClassVar[str] = None
+    """Text to display in lieu of a model list for a registry provider that does
+    not provide a list of models."""
+
     model_id_key: ClassVar[str] = ...
     """Kwarg expected by the upstream LangChain provider."""
 
@@ -177,6 +181,7 @@ class HfHubProvider(BaseProvider, HuggingFaceHub):
     name = "Hugging Face Hub"
     models = ["*"]
     model_id_key = "repo_id"
+    model_help = "See https://huggingface.co/models for a list of models."
     # ipywidgets needed to suppress tqdm warning
     # https://stackoverflow.com/questions/67998191
     # tqdm is a dependency of huggingface_hub
@@ -365,6 +370,13 @@ class SmEndpointProvider(BaseProvider, SagemakerEndpoint):
     name = "Sagemaker Endpoint"
     models = ["*"]
     model_id_key = "endpoint_name"
+    # This all needs to be on one line of markdown, for use in a table
+    model_help = ("SageMaker endpoint names are created when you deploy a model. "
+        "For more information, see "
+        '["Create your endpoint and deploy your model"]'
+        '(https://docs.aws.amazon.com/sagemaker/latest/dg/realtime-endpoints-deployment.html)'
+        "in the SageMaker documentation.")
+
     pypi_package_deps = ["boto3"]
     auth_strategy = AwsAuthStrategy()
     registry = True