Skip to main content

Conversation

This is a fully referenced Conversation. This will hold together a conversation. Ie allthe message within a conversation. All the additional properties on here used on here like(anchors/assets) are used for context that will seed the conversation. model is a calculated property, and will be the model of the last message sent if applicable.

Properties

NameType
schemaEmbeddedModelSchema
idstring
namestring
createdGroupedTimestamp
updatedGroupedTimestamp
deletedGroupedTimestamp
favoritedboolean
applicationApplication
annotationsFlattenedAnnotations
messagesFlattenedConversationMessages
modelReferencedModel
assetsFlattenedAssets
websitesFlattenedWebsites
anchorsFlattenedAnchors
typeConversationTypeEnum
groundingConversationGrounding
scoreScore
pipelineQGPTPromptPipeline
demoboolean
summariesFlattenedWorkstreamSummaries

Example

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

// TODO: Update the object below with actual values
const example: Conversation = {
"schema": null,
"id": null,
"name": null,
"created": null,
"updated": null,
"deleted": null,
"favorited": null,
"application": null,
"annotations": null,
"messages": null,
"model": null,
"assets": null,
"websites": null,
"anchors": null,
"type": null,
"grounding": null,
"score": null,
"pipeline": null,
"demo": null,
"summaries": 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 Conversation
console.log(exampleParsed)