Skip to content
Embabel Worlds

Stop offering the examples to this person, or offer them again

PUT
/api/v1/kg/studio/examples/dismissed
curl --request PUT \
  --url http://localhost:11044/api/v1/kg/studio/examples/dismissed \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "dismissed": true }'

Recorded once for the person, in their world, so another browser or another day does not bring the examples back. dismissed: false forgets the dismissal, and a reached query count with it; a saved view still hides them. Answers the examples and the new verdict.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

dismissed: true to stop offering the examples unasked; false to offer them again

Media typeapplication/json

Whether to stop offering the examples

object
dismissed
required

True to stop offering the examples unasked; false to offer them again

boolean

Example generated

{
  "dismissed": true
}

Responses

Section titled “Responses”

200

Section titled “200”

The examples and the verdict after the change

Media typeapplication/json

Query Studio’s starter queries, and whether to offer them to the signed-in person

object
examples
required

Every example this world offers, in the order its files declare them: default-world’s, the world’s own, then each installed realm’s

Array<object>

One starter query

object
cypher
required

The query, to put in the editor and run exactly as written

string
description
required

One line: what running it demonstrates

string
id
required

Unique within this world: the file it came from, then the id the file gave it

string
kind
required

ai when the query asks a model to read, judge or label as it runs, so running it costs model calls; plain for Cypher over what the world holds

string
Allowed values: ai plain
source

The realm that shipped it; absent for default-world’s and the world’s own

string
title
required

The card’s heading

string
hiddenBecause

Why they are not offered: DISMISSED, SAVED_VIEW (the person has saved a view of their own) or EXPERIENCED (they have written threshold queries of their own in Query Studio); absent while they are offered

string
Allowed values: DISMISSED SAVED_VIEW EXPERIENCED
show
required

Whether to show the examples over an empty editor without being asked

boolean
studioQueries
required

Distinct queries of their own the person has written in Query Studio, as far as the query log still holds; 0 when the verdict did not need counting

integer format: int32
threshold
required

How many distinct queries of their own retire the examples

integer format: int32

Example 

{
  "examples": [
    {
      "kind": "ai"
    }
  ],
  "hiddenBecause": "DISMISSED"
}

401

Section titled “401”

Not authenticated