whylogs container API (1.0)

Download OpenAPI specification:Download

Container that hosts the java version of whylogs behind a REST interface.

whylogs

Track pub/sub messages

Decode base64 encoded pub/sub message and track them

header Parameters
X-API-Key
string
Request Body schema: application/json
            A Google Pub\Sub interface to tracking data. Does the same thing as /track except
            it consumes a message in the format that Pub\Sub uses.
required
object (Message)

Envelope containing all metadata from pubsub push endpoint request

subscription
required
string

Key value object containing subscription name

Responses

Request samples

Content type
application/json
{
  • "message": {
    },
  • "subscription": "projects/myproject/subscriptions/mysubscription"
}

Log Data

Log a map of feature names and values or an array of data points

header Parameters
X-API-Key
string
Request Body schema: application/json

Pass the input in single entry format or a multiple entry format.

  • Set single key if you're passing a single data point with multiple features
  • Set multiple key if you're passing multiple data at once. The multiple format is is compatible with Pandas JSON output:
    import pandas as pd
    cars = {'Brand': ['Honda Civic','Toyota Corolla','Ford Focus','Audi A4'],
          'Price': [22000,25000,27000,35000] }
    df = pd.DataFrame(cars, columns = ['Brand', 'Price'])
    df.to_json(orient="split") # this is the value of `multiple`
    Here is an example from the output above
    {
      "datasetId": "demo-model",
      "timestamp": 1648162494947,
      "tags": {
          "tag1": "value1"
      },
      "multiple": {
          "columns": [
              "Brand",
              "Price"
          ],
          "data": [
              [ "Honda Civic", 22000 ],
              [ "Toyota Corolla", 25000 ],
              [ "Ford Focus", 27000 ],
              [ "Audi A4", 35000 ]
          ]
      }
    }
datasetId
required
string
timestamp
integer <int64>
object
object

Key/value pairs of col/data.

object (MultiLog)

Responses

Request samples

Content type
application/json
{
  • "datasetId": "model-2",
  • "timestamp": 0,
  • "tags": {
    },
  • "single": {
    },
  • "multiple": {
    }
}

Write Profiles

Force the container to write out the pending profiles via whatever method it's configured for.

header Parameters
X-API-Key
string

Responses

Response samples

Content type
application/json
{
  • "profilesWritten": 2,
  • "profilePaths": [
    ]
}

debug

Log Debug Info

Trigger debugging info to be logged.

header Parameters
X-API-Key
string

Responses

Tell if the http server is healthy.

Tell if the http server is healthy.

Responses