Dashboard Summary

wscat -c wss://{ACCOUNT}.askwisdom.ai/graphql \
  -H "Authorization: Bearer <jwt_token>" \
  -s graphql-ws \
  --execute '{
    "type": "start",
    "payload": {
      "query": "subscription DashboardSummary($auth: SubscriptionAuthInput!,$id: String!,$idempotencyKey: String!, $customInstructions: String,$summaryType: DashboardSummaryType) { dashboardSummary(auth: $auth, id: $id, idempotencyKey: $idempotencyKey, customInstructions: $customInstructions, summaryType: $summaryType) { chunk }",
      "variables": {
        "auth": {
          "token": "<jwt_token>"
        },
        "id": "dash_1234",
        "idempotencyKey": "abc",
        "customInstructions": "User guidelines: ....",
      }
    }
  }'

{
  "data": {
    "dashboardSummary": [
      {
        "chunk": "The summary of",
      }
    ]
  }
}

The dashboardSummary subscription allows you to generate summary of a dashboard, based on the instructions provided to it

Signature

dashboardSummary(
    auth: SubscriptionAuthInput!
    id: String!
    idempotencyKey: String!
    customInstructions: String
    summaryType: DashboardSummaryType
  ): DashboardSummaryDiff! 

Arguments

SubscriptionAuthInput!

required

Authentication credentials for the subscription. See SubscriptionAuthInput.

String!

required

The unique identifier of the dashboard whose summary is to be generated.

String!

required

The random string to be passed to avoid duplicate calls to the server.

String

The instructions to be followed while generating summary.

DashboardSummaryType

The type of summary to be generated. See DashboardSummaryType.

Response

Returns an array of DashboardSummaryDiff objects representing conversation updates. See DashboardSummaryDiff for the schema.

Usage example

A very simple example to get you started is to do the following:

 subscription DashboardSummary(
    $auth: SubscriptionAuthInput!,
    $id: String!,
    $idempotencyKey: String!,
    $customInstructions: String,
    $summaryType: DashboardSummaryType,
  ) {
    dashboardSummary(
      auth: $auth,
      id: $id,
      idempotencyKey: $idempotencyKey,
      customInstructions: $customInstructions,
      summaryType: $summaryType,
    ) {
      chunk
    }
  }

wscat -c wss://{ACCOUNT}.askwisdom.ai/graphql \
  -H "Authorization: Bearer <jwt_token>" \
  -s graphql-ws \
  --execute '{
    "type": "start",
    "payload": {
      "query": "subscription DashboardSummary($auth: SubscriptionAuthInput!,$id: String!,$idempotencyKey: String!, $customInstructions: String,$summaryType: DashboardSummaryType) { dashboardSummary(auth: $auth, id: $id, idempotencyKey: $idempotencyKey, customInstructions: $customInstructions, summaryType: $summaryType) { chunk }",
      "variables": {
        "auth": {
          "token": "<jwt_token>"
        },
        "id": "dash_1234",
        "idempotencyKey": "abc",
        "customInstructions": "User guidelines: ....",
      }
    }
  }'

{
  "data": {
    "dashboardSummary": [
      {
        "chunk": "The summary of",
      }
    ]
  }
}