doc updates

UKGovernmentBEIS · Mar 6, 2025 · 5cc222d · 5cc222d
1 parent 731c01a
commit 5cc222d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/docs/reference/_sidebar.yml b/docs/reference/_sidebar.yml
@@ -107,8 +107,6 @@ website:
           href: reference/inspect_ai.tool.qmd#toolparams
         - text: ToolParam
           href: reference/inspect_ai.tool.qmd#toolparam
-        - text: JSONType
-          href: reference/inspect_ai.tool.qmd#jsontype
         - text: tool
           href: reference/inspect_ai.tool.qmd#tool
       - section: inspect_ai.scorer
@@ -189,6 +187,8 @@ website:
           href: reference/inspect_ai.model.qmd#generateconfig
         - text: GenerateConfigArgs
           href: reference/inspect_ai.model.qmd#generateconfigargs
+        - text: ResponseSchema
+          href: reference/inspect_ai.model.qmd#responseschema
         - text: ModelOutput
           href: reference/inspect_ai.model.qmd#modeloutput
         - text: ModelUsage
@@ -427,6 +427,12 @@ website:
           href: reference/inspect_ai.util.qmd#sandboxconnection
         - text: sandboxenv
           href: reference/inspect_ai.util.qmd#sandboxenv
+        - text: JSONType
+          href: reference/inspect_ai.util.qmd#jsontype
+        - text: JSONSchema
+          href: reference/inspect_ai.util.qmd#jsonschema
+        - text: json_schema
+          href: reference/inspect_ai.util.qmd#json_schema
     - section: Inspect CLI
       href: reference/inspect_eval.qmd
       contents:

diff --git a/src/inspect_ai/model/_generate_config.py b/src/inspect_ai/model/_generate_config.py
@@ -9,6 +9,8 @@
 
 
 class ResponseSchema(BaseModel):
+    """Schema for model response when using Structured Output."""
+
     name: str
     """The name of the response schema. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."""
 

diff --git a/src/inspect_ai/util/_json.py b/src/inspect_ai/util/_json.py
@@ -54,6 +54,18 @@ class JSONSchema(BaseModel):
 
 
 def json_schema(t: Type[Any]) -> JSONSchema:
+    """Provide a JSON Schema for the specified type.
+
+    Schemas can be automatically inferred for a wide variety of
+    Python class types including Pydantic BaseModel, dataclasses,
+    and typed dicts.
+
+    Args:
+        t: Python type
+
+    Returns:
+        JSON Schema for type.
+    """
     origin = get_origin(t)
     args = get_args(t)