🌿 Fern Regeneration -- July 31, 2024 (#6)

Author: fern-api[bot]

.fernignore

@@ -1,3 +1,5 @@
 # Specify files that shouldn't be modified by Fern
 
-.github/workflows/ci.yml
+tests/test_evaluators.py
+tests/test_prompts.py
+tests/utilities.py

.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Install Fern
         run: npm install -g fern-api
       - name: Test
-        run: fern test --command "poetry run pytest -rP tests/custom"
+        run: fern test --command "poetry run pytest -rP ."
 
   publish:
     needs: [compile, test]

.mock/definition/__package__.yml

@@ -31,9 +31,6 @@ types:
       tools:
         type: optional<list<ToolConfigRequest>>
         docs: Tools associated with the agent.
-      model_config:
-        type: ModelConfigRequest
-        docs: Model config associated with the agent.
   BaseMetricResponse:
     properties:
       id:
@@ -337,6 +334,9 @@ types:
       id:
         type: string
         docs: Unique identifier for the Dataset. Starts with `ds_`.
+      directory_id:
+        type: optional<string>
+        docs: ID of the directory that the file is in on Humanloop.
       name:
         type: string
         docs: Name of the Dataset, which is used as a unique identifier.
@@ -578,9 +578,6 @@ types:
       evaluator_type:
         type: string
         docs: Type of evaluator.
-      model_config:
-        type: optional<ModelConfigResponse>
-        docs: The model config defining the LLM evaluator.
       code:
         type: optional<string>
         docs: >-
@@ -593,11 +590,8 @@ types:
         type: optional<EvaluatorReturnTypeEnum>
         docs: The type of the return value of the evaluator.
   EvaluatorLogResponse:
-    docs: Submit Evaluator judgment for another File's Log.
+    docs: General request for creating a Log
     properties:
-      id:
-        type: string
-        docs: Unique identifier for the Log.
       output:
         type: optional<string>
         docs: >-
@@ -627,11 +621,10 @@ types:
           internal systems) by passing the same `session_id` in subsequent log
           requests.
       parent_id:
-        type: optional<string>
+        type: string
         docs: >-
-          Unique identifier for the parent Log in a Session. Should only be
-          provided if `session_id` is provided. If provided, the Log will be
-          nested under the parent Log within the Session.
+          Identifier of the evaluated Log. The newly created Log will have this
+          one set as parent.
       inputs:
         type: optional<map<string, unknown>>
         docs: The inputs passed to the prompt template.
@@ -664,6 +657,9 @@ types:
         type: optional<string>
         docs: The name of the Environment the Log is associated to.
       judgment: optional<unknown>
+      id:
+        type: string
+        docs: Unique identifier for the Log.
       evaluator:
         type: EvaluatorResponse
         docs: The Evaluator used to generate the judgment.
@@ -685,6 +681,13 @@ types:
       id:
         type: string
         docs: Unique identifier for the Evaluator.
+      directory_id:
+        type: optional<string>
+        docs: ID of the directory that the file is in on Humanloop.
+      commit_message:
+        type: optional<string>
+        docs: Message describing the changes made.
+      spec: EvaluatorResponseSpec
       name:
         type: string
         docs: Name of the Evaluator, which is used as a unique identifier.
@@ -704,10 +707,6 @@ types:
         docs: The user who created the Prompt.
       status: VersionStatus
       last_used_at: datetime
-      commit_message:
-        type: optional<string>
-        docs: Message describing the changes made.
-      spec: EvaluatorResponseSpec
       version_logs_count:
         type: integer
         docs: The number of logs that have been generated for this Prompt Version
@@ -1789,11 +1788,8 @@ types:
       - literal<"required">
       - ToolChoice
   PromptLogResponse:
-    docs: Request for creating a Prompt log.
+    docs: General request for creating a Log
     properties:
-      id:
-        type: string
-        docs: Unique identifier for the Log.
       output_message:
         type: optional<ChatMessage>
         docs: The message returned by the provider.
@@ -1902,6 +1898,9 @@ types:
       environment:
         type: optional<string>
         docs: The name of the Environment the Log is associated to.
+      id:
+        type: string
+        docs: Unique identifier for the Log.
   PromptResponseTemplate:
     discriminated: false
     docs: >-
@@ -1920,7 +1919,15 @@ types:
       - string
       - list<string>
   PromptResponse:
-    docs: Request model for creating a new Prompt
+    docs: >-
+      Base type that all File Responses should inherit from.
+
+
+      Attributes defined here are common to all File Responses and should be
+      overridden
+
+      in the inheriting classes with documentation and appropriate Field
+      definitions.
     properties:
       path:
         type: string
@@ -1930,27 +1937,9 @@ types:
       id:
         type: string
         docs: Unique identifier for the Prompt.
-      name:
-        type: string
-        docs: Name of the Prompt.
-      version_id:
-        type: string
-        docs: >-
-          Unique identifier for the specific Prompt Version. If no query params
-          provided, the default deployed Prompt Version is returned.
-      type: optional<literal<"prompt">>
-      environments:
-        type: optional<list<EnvironmentResponse>>
-        docs: The list of environments the Prompt Version is deployed to.
-      created_at: datetime
-      updated_at: datetime
-      created_by:
-        type: optional<UserResponse>
-        docs: The user who created the Prompt.
-      status:
-        type: VersionStatus
-        docs: The status of the Prompt Version.
-      last_used_at: datetime
+      directory_id:
+        type: optional<string>
+        docs: ID of the directory that the file is in on Humanloop.
       model:
         type: string
         docs: >-
@@ -2029,6 +2018,27 @@ types:
       commit_message:
         type: optional<string>
         docs: Message describing the changes made.
+      name:
+        type: string
+        docs: Name of the Prompt.
+      version_id:
+        type: string
+        docs: >-
+          Unique identifier for the specific Prompt Version. If no query params
+          provided, the default deployed Prompt Version is returned.
+      type: optional<literal<"prompt">>
+      environments:
+        type: optional<list<EnvironmentResponse>>
+        docs: The list of environments the Prompt Version is deployed to.
+      created_at: datetime
+      updated_at: datetime
+      created_by:
+        type: optional<UserResponse>
+        docs: The user who created the Prompt.
+      status:
+        type: VersionStatus
+        docs: The status of the Prompt Version.
+      last_used_at: datetime
       version_logs_count:
         type: integer
         docs: The number of logs that have been generated for this Prompt Version
@@ -2213,11 +2223,8 @@ types:
           Values needed to setup the Tool, defined in JSON Schema format:
           https://json-schema.org/
   ToolLogResponse:
-    docs: Request for creating a Tool log.
+    docs: General request for creating a Log
     properties:
-      id:
-        type: string
-        docs: Unique identifier for the Log.
       output:
         type: optional<string>
         docs: >-
@@ -2283,6 +2290,9 @@ types:
       environment:
         type: optional<string>
         docs: The name of the Environment the Log is associated to.
+      id:
+        type: string
+        docs: Unique identifier for the Log.
       tool:
         type: ToolResponse
         docs: Tool details used to generate the Log.
@@ -2626,7 +2636,15 @@ types:
       - ToolLogResponse
       - EvaluatorLogResponse
   ToolResponse:
-    docs: Request to create a new Tool.
+    docs: >-
+      Base type that all File Responses should inherit from.
+
+
+      Attributes defined here are common to all File Responses and should be
+      overridden
+
+      in the inheriting classes with documentation and appropriate Field
+      definitions.
     properties:
       path:
         type: string
@@ -2636,6 +2654,28 @@ types:
       id:
         type: string
         docs: Unique identifier for the Tool.
+      directory_id:
+        type: optional<string>
+        docs: ID of the directory that the file is in on Humanloop.
+      function:
+        type: optional<ToolFunction>
+        docs: >-
+          Callable function specification of the Tool shown to the model for
+          tool calling.
+      source_code:
+        type: optional<string>
+        docs: Code source of the Tool.
+      setup_values:
+        type: optional<map<string, unknown>>
+        docs: >-
+          Values needed to setup the Tool, defined in JSON Schema format:
+          https://json-schema.org/
+      tool_type:
+        type: optional<FilesToolType>
+        docs: Type of Tool.
+      commit_message:
+        type: optional<string>
+        docs: Message describing the changes made.
       name:
         type: string
         docs: Name of the Tool, which is used as a unique identifier.
@@ -2657,25 +2697,6 @@ types:
         type: VersionStatus
         docs: The status of the Tool Version.
       last_used_at: datetime
-      function:
-        type: optional<ToolFunction>
-        docs: >-
-          Callable function specification of the Tool shown to the model for
-          tool calling.
-      source_code:
-        type: optional<string>
-        docs: Code source of the Tool.
-      setup_values:
-        type: optional<map<string, unknown>>
-        docs: >-
-          Values needed to setup the Tool, defined in JSON Schema format:
-          https://json-schema.org/
-      tool_type:
-        type: optional<FilesToolType>
-        docs: Type of Tool.
-      commit_message:
-        type: optional<string>
-        docs: Message describing the changes made.
       version_logs_count:
         type: integer
         docs: The number of logs that have been generated for this Tool Version

.mock/definition/api.yml

@@ -3,7 +3,7 @@ error-discrimination:
   strategy: status-code
 display-name: Humanloop API
 environments:
-  Default: https://neostaging.humanloop.ml/v5
+  Default: https://api.humanloop.com/v5
 default-environment: Default
 auth-schemes:
   APIKeyHeader:

.mock/definition/datasets.yml

@@ -130,11 +130,12 @@ service:
             path:
               type: optional<string>
               docs: >-
-                Path of the Dataset, including the name, which is used as a
-                unique identifier.
+                Path of the Dataset, including the name. This locates the
+                Dataset in the Humanloop filesystem and is used as as a unique
+                identifier. Example: `folder/name` or just `name`.
             id:
               type: optional<string>
-              docs: ID for an existing Dataset to update.
+              docs: ID for an existing Dataset.
             datapoints:
               docs: >-
                 The Datapoints to create this Dataset version with. Modify the
@@ -354,6 +355,7 @@ service:
             body:
               path: path
               id: id
+              directory_id: directory_id
               name: name
               version_id: version_id
               type: dataset
@@ -590,6 +592,7 @@ service:
             body:
               path: path
               id: id
+              directory_id: directory_id
               name: name
               version_id: version_id
               type: dataset
@@ -717,21 +720,7 @@ service:
                 file:
                   path: path
                   id: id
-                  name: name
-                  version_id: version_id
-                  type: prompt
-                  environments:
-                    - id: id
-                      created_at: '2024-01-15T09:30:00Z'
-                      name: name
-                      tag: default
-                  created_at: '2024-01-15T09:30:00Z'
-                  updated_at: '2024-01-15T09:30:00Z'
-                  created_by:
-                    id: id
-                    email_address: email_address
-                  status: uncommitted
-                  last_used_at: '2024-01-15T09:30:00Z'
+                  directory_id: directory_id
                   model: model
                   endpoint: complete
                   template: template
@@ -756,6 +745,21 @@ service:
                       id: id
                       version_id: version_id
                   commit_message: commit_message
+                  name: name
+                  version_id: version_id
+                  type: prompt
+                  environments:
+                    - id: id
+                      created_at: '2024-01-15T09:30:00Z'
+                      name: name
+                      tag: default
+                  created_at: '2024-01-15T09:30:00Z'
+                  updated_at: '2024-01-15T09:30:00Z'
+                  created_by:
+                    id: id
+                    email_address: email_address
+                  status: uncommitted
+                  last_used_at: '2024-01-15T09:30:00Z'
                   version_logs_count: 1
                   total_logs_count: 1
                   inputs: