Skip to main content

Hint

This is a hint that is attached to an asset, used for suggested_queries, and hints given via the qgpt flow.

Properties

NameType
schemaEmbeddedModelSchema
idstring
createdGroupedTimestamp
updatedGroupedTimestamp
deletedGroupedTimestamp
mechanismMechanismEnum
assetReferencedAsset
typeHintTypeEnum
textstring
modelReferencedModel
scoreScore

Example

import { Hint } from '@pieces.app/pieces-os-client'

// TODO: Update the object below with actual values
const example: Hint = {
"schema": null,
"id": null,
"created": null,
"updated": null,
"deleted": null,
"mechanism": null,
"asset": null,
"type": null,
"text": null,
"model": null,
"score": null,
}

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as Hint
console.log(exampleParsed)