Chat

This is a type used in Stencila Schema for conversational interactions in documents.

It combines CreativeWork metadata with Executable behavior so a chat can be stored, rendered, re-executed, and linked to document editing workflows. Unlike a plain message transcript, it can carry model configuration, prompt rendering, targeted document nodes, and mixed block content.

Key properties include prompt, modelParameters, targetNodes, and content. Additional metadata and execution features are inherited from CreativeWork and Executable.

This type is marked as unstable and is subject to change.

Analogues

The following external types, elements, or nodes are similar to a Chat:

OpenAI chat completion conversation: Close conversational analogue, though Stencila stores chats as reusable executable document artifacts with block content and workflow metadata.

Anthropic messages conversation: Close provider-level analogue for structured message exchanges.

Properties

The Chat type has these properties:

Name	Description	Type	Inherited from
`isEmbedded`	Whether the chat is embedded within a document (i.e. is not standalone).	`Boolean`	-
`prompt`	The prompt selected, rendered and provided to the model	`PromptBlock`	-
`modelParameters`	Model selection and inference parameters.	`ModelParameters`	-
`targetNodes`	The ids of the nodes that this chat is targeting	`String`*	-
`content`	The messages, and optionally other content, that make up the chat.	`Block`*	-
`workType`	The type of `CreativeWork` (e.g. article, book, software application).	`CreativeWorkType`	`CreativeWork`
`doi`	The work's Digital Object Identifier (https://doi.org/).	`String`	`CreativeWork`
`about`	The subject matter of the content.	`ThingVariant`*	`CreativeWork`
`abstract`	A short description that summarizes a `CreativeWork`.	`Block`*	`CreativeWork`
`authors`	The authors of the `CreativeWork`.	`Author`*	`CreativeWork`
`provenance`	A summary of the provenance of the content within the work.	`ProvenanceCount`*	`CreativeWork`
`contributors`	A secondary contributor to the `CreativeWork`.	`Author`*	`CreativeWork`
`editors`	People who edited the `CreativeWork`.	`Person`*	`CreativeWork`
`maintainers`	The maintainers of the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`comments`	Comments about this creative work.	`Comment`*	`CreativeWork`
`dateCreated`	Date/time of creation.	`DateTime`	`CreativeWork`
`dateReceived`	Date/time that work was received.	`DateTime`	`CreativeWork`
`dateAccepted`	Date/time of acceptance.	`DateTime`	`CreativeWork`
`dateModified`	Date/time of most recent modification.	`DateTime`	`CreativeWork`
`datePublished`	Date of first publication.	`DateTime`	`CreativeWork`
`funders`	People or organizations that funded the `CreativeWork`.	(`Person` \| `Organization`)*	`CreativeWork`
`fundedBy`	Grants that funded the `CreativeWork`; reverse of `fundedItems`.	(`Grant` \| `MonetaryGrant`)*	`CreativeWork`
`genre`	Genre of the creative work, broadcast channel or group.	`String`*	`CreativeWork`
`keywords`	Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.	`String`*	`CreativeWork`
`isPartOf`	An item or other CreativeWork that this CreativeWork is a part of.	`CreativeWorkVariant`	`CreativeWork`
`licenses`	License documents that applies to this content, typically indicated by URL, but may be a `CreativeWork` itself.	(`CreativeWorkVariant` \| `String`)*	`CreativeWork`
`parts`	Elements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.	`CreativeWorkVariant`*	`CreativeWork`
`publisher`	A publisher of the CreativeWork.	`Person` \| `Organization`	`CreativeWork`
`bibliography`	A bibliography of references which may be cited in the work.	`Bibliography`	`CreativeWork`
`references`	References to other creative works, such as another publication, web page, scholarly article, etc.	`Reference`*	`CreativeWork`
`text`	The textual content of this creative work.	`Text`	`CreativeWork`
`title`	The title of the creative work.	`Inline`*	`CreativeWork`
`repository`	URL of the repository where the un-compiled, human readable source of the work is located.	`String`	`CreativeWork`
`path`	The file system path of the source of the work.	`String`	`CreativeWork`
`commit`	The commit hash (or similar) of the source of the work.	`String`	`CreativeWork`
`version`	The version of the creative work.	`String` \| `Number`	`CreativeWork`
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`id`	The identifier for this item.	`String`	`Entity`
`alternateNames`	Alternate names (aliases) for the item.	`String`*	`Thing`
`description`	A description of the item.	`String`	`Thing`
`identifiers`	Any kind of identifier for any kind of Thing.	(`PropertyValue` \| `String`)*	`Thing`
`images`	Images of the item.	`ImageObject`*	`Thing`
`name`	The name of the item.	`String`	`Thing`
`url`	The URL of the item.	`String`	`Thing`

The Chat type is related to these types:

Parents: CreativeWorkExecutable

Children: none

Bindings

The Chat type is represented in:

JSON-LD

JSON Schema

Python class Chat

Rust struct Chat

TypeScript class Chat

This documentation was generated from Chat.yaml by docs_types.rs.

I'm happy to help with any questions or tasks you may have. Please go ahead and ask away, and I'll do my best to provide a helpful and accurate response. What's on your mind?

Chat

Analogues

Properties

Related

Bindings