hume 0.6.0 → 0.6.2

package/.mock/definition/expression-measurement/batch.yml

@@ -0,0 +1,352 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-jobs:
+      path: /v0/batch/jobs
+      method: GET
+      auth: true
+      docs: Sort and filter jobs.
+      display-name: List jobs
+      request:
+        name: BatchListJobsRequest
+        query-parameters:
+          limit:
+            type: optional<integer>
+            docs: The maximum number of jobs to include in the response.
+          status:
+            type: optional<root.Status>
+            allow-multiple: true
+            docs: Include only jobs with these statuses.
+          when:
+            type: optional<root.When>
+            docs: >-
+              Include only jobs that were created before or after
+              `timestamp_ms`.
+          timestamp_ms:
+            type: optional<integer>
+            docs: Defaults to the current date and time. See `when`.
+          sort_by:
+            type: optional<root.SortBy>
+            docs: The job timestamp to sort by.
+          direction:
+            type: optional<root.Direction>
+            docs: The sort direction.
+          type:
+            type: optional<root.Type>
+            allow-multiple: true
+            docs: Include only jobs of these types.
+      response:
+        docs: ''
+        type: list<root.UnionJob>
+      examples:
+        - response:
+            body:
+              - job_id: job_id
+                request:
+                  callback_url: null
+                  files:
+                    - filename: filename
+                      md5sum: md5sum
+                      content_type: content_type
+                  models:
+                    burst: {}
+                    face:
+                      descriptions: null
+                      facs: null
+                      fps_pred: 3
+                      identify_faces: false
+                      min_face_size: 60
+                      prob_threshold: 0.99
+                      save_faces: false
+                    facemesh: {}
+                    language:
+                      granularity: word
+                      identify_speakers: false
+                      sentiment: null
+                      toxicity: null
+                    ner:
+                      identify_speakers: false
+                    prosody:
+                      granularity: utterance
+                      identify_speakers: false
+                      window: null
+                  notify: true
+                  registry_files: []
+                  text: []
+                  urls:
+                    - https://hume-tutorials.s3.amazonaws.com/faces.zip
+                state:
+                  created_timestamp_ms: 1712587158717
+                  ended_timestamp_ms: 1712587159274
+                  num_errors: 0
+                  num_predictions: 10
+                  started_timestamp_ms: 1712587158800
+                  status: COMPLETED
+                type: INFERENCE
+                user_id: user_id
+    start-inference-job:
+      path: /v0/batch/jobs
+      method: POST
+      auth: true
+      docs: Start a new measurement inference job.
+      display-name: Start inference job
+      request:
+        body: root.InferenceBaseRequest
+      response:
+        docs: ''
+        type: root.JobId
+      examples:
+        - request:
+            urls:
+              - https://hume-tutorials.s3.amazonaws.com/faces.zip
+            notify: true
+          response:
+            body:
+              job_id: job_id
+    get-job-details:
+      path: /v0/batch/jobs/{id}
+      method: GET
+      auth: true
+      docs: Get the request details and state of a given job.
+      path-parameters:
+        id: string
+      display-name: Get job details
+      response:
+        docs: ''
+        type: root.UnionJob
+      examples:
+        - name: Embedding Generation
+          path-parameters:
+            id: job_id
+          response:
+            body:
+              type: EMBEDDING_GENERATION
+              job_id: string
+              request:
+                registry_file_details:
+                  - file_id: string
+                    file_url: string
+              state:
+                status: QUEUED
+                created_timestamp_ms: 0
+              user_id: string
+        - name: Inference
+          path-parameters:
+            id: job_id
+          response:
+            body:
+              type: INFERENCE
+              job_id: job_id
+              request:
+                callback_url: null
+                files: []
+                models:
+                  burst: {}
+                  face:
+                    descriptions: null
+                    facs: null
+                    fps_pred: 3
+                    identify_faces: false
+                    min_face_size: 60
+                    prob_threshold: 0.99
+                    save_faces: false
+                  facemesh: {}
+                  language:
+                    granularity: word
+                    identify_speakers: false
+                    sentiment: null
+                    toxicity: null
+                  ner:
+                    identify_speakers: false
+                  prosody:
+                    granularity: utterance
+                    identify_speakers: false
+                    window: null
+                notify: true
+                registry_files: []
+                text: []
+                urls:
+                  - https://hume-tutorials.s3.amazonaws.com/faces.zip
+              state:
+                created_timestamp_ms: 1712590457884
+                ended_timestamp_ms: 1712590462252
+                num_errors: 0
+                num_predictions: 10
+                started_timestamp_ms: 1712590457995
+                status: COMPLETED
+              user_id: user_id
+    get-job-predictions:
+      path: /v0/batch/jobs/{id}/predictions
+      method: GET
+      auth: true
+      docs: >-
+        Get the JSON predictions of a completed measurement or custom models
+        inference job.
+      path-parameters:
+        id: string
+      display-name: Get job predictions
+      response:
+        docs: ''
+        type: list<root.UnionPredictResult>
+      examples:
+        - path-parameters:
+            id: job_id
+          response:
+            body:
+              - source:
+                  type: url
+                  url: https://hume-tutorials.s3.amazonaws.com/faces.zip
+                results:
+                  predictions:
+                    - file: faces/100.jpg
+                      models:
+                        face:
+                          metadata: null
+                          grouped_predictions:
+                            - id: unknown
+                              predictions:
+                                - frame: 0
+                                  time: 0
+                                  prob: 0.9994111061096191
+                                  box:
+                                    x: 1187.885986328125
+                                    'y': 1397.697509765625
+                                    w: 1401.668701171875
+                                    h: 1961.424560546875
+                                  emotions:
+                                    - name: Admiration
+                                      score: 0.10722749680280685
+                                    - name: Adoration
+                                      score: 0.06395940482616425
+                                    - name: Aesthetic Appreciation
+                                      score: 0.05811462551355362
+                                    - name: Amusement
+                                      score: 0.14187128841876984
+                                    - name: Anger
+                                      score: 0.02804684266448021
+                                    - name: Anxiety
+                                      score: 0.2713485360145569
+                                    - name: Awe
+                                      score: 0.33812594413757324
+                                    - name: Awkwardness
+                                      score: 0.1745193600654602
+                                    - name: Boredom
+                                      score: 0.23600080609321594
+                                    - name: Calmness
+                                      score: 0.18988418579101562
+                                    - name: Concentration
+                                      score: 0.44288986921310425
+                                    - name: Confusion
+                                      score: 0.39346569776535034
+                                    - name: Contemplation
+                                      score: 0.31002455949783325
+                                    - name: Contempt
+                                      score: 0.048870109021663666
+                                    - name: Contentment
+                                      score: 0.0579497292637825
+                                    - name: Craving
+                                      score: 0.06544201076030731
+                                    - name: Desire
+                                      score: 0.05526508390903473
+                                    - name: Determination
+                                      score: 0.08590991795063019
+                                    - name: Disappointment
+                                      score: 0.19508258998394012
+                                    - name: Disgust
+                                      score: 0.031529419124126434
+                                    - name: Distress
+                                      score: 0.23210826516151428
+                                    - name: Doubt
+                                      score: 0.3284550905227661
+                                    - name: Ecstasy
+                                      score: 0.040716782212257385
+                                    - name: Embarrassment
+                                      score: 0.1467227339744568
+                                    - name: Empathic Pain
+                                      score: 0.07633581757545471
+                                    - name: Entrancement
+                                      score: 0.16245244443416595
+                                    - name: Envy
+                                      score: 0.03267110139131546
+                                    - name: Excitement
+                                      score: 0.10656816512346268
+                                    - name: Fear
+                                      score: 0.3115977346897125
+                                    - name: Guilt
+                                      score: 0.11615975946187973
+                                    - name: Horror
+                                      score: 0.19795553386211395
+                                    - name: Interest
+                                      score: 0.3136432468891144
+                                    - name: Joy
+                                      score: 0.06285581737756729
+                                    - name: Love
+                                      score: 0.06339752674102783
+                                    - name: Nostalgia
+                                      score: 0.05866732448339462
+                                    - name: Pain
+                                      score: 0.07684041559696198
+                                    - name: Pride
+                                      score: 0.026822954416275024
+                                    - name: Realization
+                                      score: 0.30000734329223633
+                                    - name: Relief
+                                      score: 0.04414166510105133
+                                    - name: Romance
+                                      score: 0.042728863656520844
+                                    - name: Sadness
+                                      score: 0.14773206412792206
+                                    - name: Satisfaction
+                                      score: 0.05902980640530586
+                                    - name: Shame
+                                      score: 0.08103451132774353
+                                    - name: Surprise (negative)
+                                      score: 0.25518184900283813
+                                    - name: Surprise (positive)
+                                      score: 0.28845661878585815
+                                    - name: Sympathy
+                                      score: 0.062488824129104614
+                                    - name: Tiredness
+                                      score: 0.1559651643037796
+                                    - name: Triumph
+                                      score: 0.01955239288508892
+                                  facs: null
+                                  descriptions: null
+                  errors: []
+    get-job-artifacts:
+      path: /v0/batch/jobs/{id}/artifacts
+      method: GET
+      auth: true
+      docs: >-
+        Get the artifacts ZIP of a completed measurement or custom models
+        inference job.
+      path-parameters:
+        id: string
+      display-name: Get job artifacts
+      response:
+        docs: ''
+        type: file
+    start-inference-job-from-local-file:
+      path: /v0/batch/jobs
+      method: POST
+      auth: true
+      docs: Start a new batch inference job.
+      display-name: Start inference job from local file
+      request:
+        name: BatchStartInferenceJobFromLocalFileRequest
+        body:
+          properties:
+            json: optional<root.InferenceBaseRequest>
+            file: list<file>
+        content-type: multipart/form-data
+      response:
+        docs: ''
+        type: root.JobId
+      examples:
+        - request: {}
+          response:
+            body:
+              job_id: job_id