🌿 Fern Regeneration -- July 27, 2024 (#4)

* SDK regeneration

* address pydantic naming conflict

* 🌿 SDK regeneration

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>

Author: fern-api[bot]

.mock/definition/__package__.yml

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

.mock/definition/api.yml

@@ -8,7 +8,7 @@ service:
       path: /datasets
       method: GET
       auth: true
-      docs: List a list of all Datasets.
+      docs: List all Datasets.
       pagination:
         offset: $request.page
         results: $response.records
@@ -163,7 +163,7 @@ service:
       errors:
         - root.UnprocessableEntityError
       examples:
-        - name: Create dataset
+        - name: AddToDataset
           request:
             path: test-questions
             datapoints:
@@ -189,6 +189,43 @@ service:
               status: committed
               last_used_at: '2024-05-01T12:00:00Z'
               datapoints_count: 4
+        - name: CreateSupportDataset
+          request:
+            path: datasets/support-queries
+            datapoints:
+              - messages:
+                  - role: user
+                    content: >-
+                      Hi Humanloop support team, I'm having trouble
+                      understanding how to use the evaluations feature in your
+                      software. Can you provide a step-by-step guide or any
+                      resources to help me get started?
+                target:
+                  feature: evaluations
+                  issue: needs step-by-step guide
+              - messages:
+                  - role: user
+                    content: >-
+                      Hi there, I'm interested in fine-tuning a language model
+                      using your software. Can you explain the process and
+                      provide any best practices or guidelines?
+                target:
+                  feature: fine-tuning
+                  issue: process explanation and best practices
+            action: add
+            commit_message: Add two new questions and answers
+          response:
+            body:
+              id: ds_mno345
+              path: test-questions
+              name: test-questions
+              version_id: dsv_pqr678
+              type: dataset
+              created_at: '2024-05-01T12:00:00Z'
+              updated_at: '2024-05-01T12:00:00Z'
+              status: committed
+              last_used_at: '2024-05-01T12:00:00Z'
+              datapoints_count: 4
     get:
       path: /datasets/{id}
       method: GET
@@ -337,11 +374,11 @@ service:
               datapoints_count: 1
               datapoints:
                 - inputs:
-                    inputs: inputs
+                    key: value
                   messages:
                     - role: user
                   target:
-                    target: target
+                    key: value
                   id: id
     listDatapoints:
       path: /datasets/{id}/datapoints
@@ -573,11 +610,11 @@ service:
               datapoints_count: 1
               datapoints:
                 - inputs:
-                    inputs: inputs
+                    key: value
                   messages:
                     - role: user
                   target:
-                    target: target
+                    key: value
                   id: id
     setDeployment:
       path: /datasets/{id}/environments/{environment_id}
@@ -705,6 +742,8 @@ service:
                   stop: stop
                   presence_penalty: 1.1
                   frequency_penalty: 1.1
+                  other:
+                    key: value
                   seed: 1
                   response_format:
                     type: json_object

.mock/definition/datasets.yml

@@ -719,34 +719,36 @@ service:
                     id: id
                   log:
                     id: id
-                    config:
+                    prompt:
+                      path: path
                       id: id
-                      type: model
+                      name: name
+                      version_id: version_id
+                      created_at: '2024-01-15T09:30:00Z'
+                      updated_at: '2024-01-15T09:30:00Z'
+                      status: uncommitted
+                      last_used_at: '2024-01-15T09:30:00Z'
                       model: model
-                    evaluation_results:
-                      - id: id
-                        evaluator_id: evaluator_id
-                        evaluator_version_id: evaluator_version_id
-                        log_id: log_id
-                        updated_at: '2024-01-15T09:30:00Z'
-                        created_at: '2024-01-15T09:30:00Z'
-                    observability_status: pending
-                    updated_at: '2024-01-15T09:30:00Z'
+                      version_logs_count: 1
+                      total_logs_count: 1
+                      inputs:
+                        - name: name
                   evaluator_logs:
                     - id: id
-                      config:
+                      prompt:
+                        path: path
                         id: id
-                        type: model
+                        name: name
+                        version_id: version_id
+                        created_at: '2024-01-15T09:30:00Z'
+                        updated_at: '2024-01-15T09:30:00Z'
+                        status: uncommitted
+                        last_used_at: '2024-01-15T09:30:00Z'
                         model: model
-                      evaluation_results:
-                        - id: id
-                          evaluator_id: evaluator_id
-                          evaluator_version_id: evaluator_version_id
-                          log_id: log_id
-                          updated_at: '2024-01-15T09:30:00Z'
-                          created_at: '2024-01-15T09:30:00Z'
-                      observability_status: pending
-                      updated_at: '2024-01-15T09:30:00Z'
+                        version_logs_count: 1
+                        total_logs_count: 1
+                        inputs:
+                          - name: name
               page: 1
               size: 1
               total: 1

.mock/definition/evaluations.yml

@@ -495,6 +495,120 @@ service:
                   total_logs_count: 1
                   inputs:
                     - name: answer
+    log:
+      path: /evaluators/log
+      method: POST
+      auth: true
+      docs: >-
+        Submit evalutor judgment for an existing Log. Creates a new Log and
+        makes evaluated one its parent.
+      display-name: Log
+      request:
+        name: CreateEvaluatorLogRequest
+        query-parameters:
+          version_id:
+            type: optional<string>
+            docs: ID of the Evaluator version to log against.
+          environment:
+            type: optional<string>
+            docs: Name of the Environment identifying a deployed version to log to.
+        body:
+          properties:
+            path:
+              type: optional<string>
+              docs: >-
+                Path of the Evaluator, including the name, which is used as a
+                unique identifier.
+            id:
+              type: optional<string>
+              docs: ID for an existing Evaluator to update.
+            output:
+              type: optional<string>
+              docs: >-
+                Generated output from the LLM. Only populated for LLM Evaluator
+                Logs.
+            created_at:
+              type: optional<datetime>
+              docs: 'User defined timestamp for when the log was created. '
+            error:
+              type: optional<string>
+              docs: Error message if the log is an error.
+            provider_latency:
+              type: optional<double>
+              docs: Duration of the logged event in seconds.
+            provider_request:
+              type: optional<map<string, unknown>>
+              docs: >-
+                Raw request sent to provider. Only populated for LLM Evaluator
+                Logs.
+            provider_response:
+              type: optional<map<string, unknown>>
+              docs: >-
+                Raw response received the provider. Only populated for LLM
+                Evaluator Logs.
+            session_id:
+              type: optional<string>
+              docs: >-
+                Unique identifier for the Session to associate the Log to.
+                Allows you to record multiple Logs to a Session (using an ID
+                kept by your internal systems) by passing the same `session_id`
+                in subsequent log requests.
+            parent_id:
+              type: string
+              docs: >-
+                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.
+            source:
+              type: optional<string>
+              docs: Identifies where the model was called from.
+            metadata:
+              type: optional<map<string, unknown>>
+              docs: Any additional metadata to record.
+            save:
+              type: optional<boolean>
+              docs: >-
+                Whether the request/response payloads will be stored on
+                Humanloop.
+              default: true
+            source_datapoint_id:
+              type: optional<string>
+              docs: >-
+                Unique identifier for the Datapoint that this Log is derived
+                from. This can be used by Humanloop to associate Logs to
+                Evaluations. If provided, Humanloop will automatically associate
+                this Log to Evaluations that require a Log for this
+                Datapoint-Version pair.
+            batches:
+              type: optional<list<string>>
+              docs: >-
+                Array of Batch Ids that this log is part of. Batches are used to
+                group Logs together for offline Evaluations
+            user:
+              type: optional<string>
+              docs: End-user ID related to the Log.
+            environment:
+              type: optional<string>
+              docs: The name of the Environment the Log is associated to.
+              name: createEvaluatorLogRequestEnvironment
+            judgment: optional<unknown>
+            spec: optional<CreateEvaluatorLogRequestSpec>
+      response:
+        docs: Successful Response
+        type: root.CreateEvaluatorLogResponse
+      errors:
+        - root.UnprocessableEntityError
+      examples:
+        - request:
+            parent_id: parent_id
+          response:
+            body:
+              id: id
+              parent_id: parent_id
+              session_id: session_id
+              version_id: version_id
 types:
   SrcExternalAppModelsV5EvaluatorsEvaluatorRequestSpec:
     discriminated: false
@@ -503,3 +617,10 @@ types:
       - root.CodeEvaluatorRequest
       - root.HumanEvaluatorRequest
       - root.ExternalEvaluatorRequest
+  CreateEvaluatorLogRequestSpec:
+    discriminated: false
+    union:
+      - root.LlmEvaluatorRequest
+      - root.CodeEvaluatorRequest
+      - root.HumanEvaluatorRequest
+      - root.ExternalEvaluatorRequest

.mock/definition/evaluators.yml

@@ -57,7 +57,7 @@ service:
               returned.
       response:
         docs: Successful Response
-        type: root.PaginatedPromptLogResponse
+        type: root.PaginatedDataLogResponse
       errors:
         - root.UnprocessableEntityError
       examples:
@@ -115,7 +115,7 @@ service:
       display-name: Get Log
       response:
         docs: Successful Response
-        type: root.PromptLogResponse
+        type: root.SrcExternalAppModelsV5LogsLogResponse
       errors:
         - root.UnprocessableEntityError
       examples: