Class SystemLanguageModelSchema

Create generable schema to provide to SystemLanguageModel objects to get back structured, non-string responses.

Example

Getting Structured Responses

// CREATE A PROMPT TO SEND TO MODEL
const prompt = `Generate tag suggestions to use classifying the  * text below:

${draft.content}`

// CREATE MODEL OBJECT
let m = new SystemLanguageModel()
// CREATE SCHEMA TO GET BACK STRUCTURED DATA
let schema = SystemLanguageModelSchema.create("Tag Suggestions", "A set of tag suggestions to classify a text.")
schema.addStringArray("tags", "A list of tags to assign the text")
// QUERY THE MODEL
let response = m.respond(prompt, schema)

Index

Constructor

constructor create

Values

addBoolean addBooleanArray addInt addIntArray addNumber addNumberArray addString addStringArray

Constructor

constructor

new SystemLanguageModelSchema(
name: string,
description: string,
): SystemLanguageModelSchema
Create new instance.
Parameters
- name: string
  Human-readable name for property
- description: string
  Detail regarding the use of the property
Returns SystemLanguageModelSchema

`Static`create

create(name: string, description: string): SystemLanguageModelSchema
Create new instance
Parameters
- name: string
  Human-readable name for property
- description: string
  Detail regarding the use of the property
Returns SystemLanguageModelSchema

Values

addBoolean

addBoolean(name: string, description: string): any
Add a boolean type property
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addBooleanArray

addBooleanArray(name: string, description: string): any
Add an array of boolean type properties
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addInt

addInt(name: string, description: string): any
Add an integer type property
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addIntArray

addIntArray(name: string, description: string): any
Add an array of integer type properties
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addNumber

addNumber(name: string, description: string): any
Add a number type property
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addNumberArray

addNumberArray(name: string, description: string): any
Add an array of number type properties
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addString

addString(name: string, description: string): any
Add a string type property
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any
addString(name: string, description: string): any
Add a string type property
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

addStringArray

addStringArray(name: string, description: string): any
Add an array of strings type properties
Parameters
- name: string
  Human-readable name for property. This will translate to a key for the value in returned object.
- description: string
  Details on the usage and meaning of the property to guide the model in creation of results.
Returns any

Class SystemLanguageModelSchema

Example

Index

Constructor

Values

Constructor

constructor

Parameters

Returns SystemLanguageModelSchema

Staticcreate

Parameters

Returns SystemLanguageModelSchema

Values

addBoolean

Parameters

Returns any

addBooleanArray

Parameters

Returns any

addInt

Parameters

Returns any

addIntArray

Parameters

Returns any

addNumber

Parameters

Returns any

addNumberArray

Parameters

Returns any

addString

Parameters

Returns any

Parameters

Returns any

addStringArray

Parameters

Returns any

Settings

On This Page

`Static`create