Class Chat

jsonSchemaService

addFunctionParameter

• addFunctionParameter(propertyName, type, options?): Chat

• Parameters

  • propertyName: string
  • type: any
  • Optionaloptions: any

  Returns Chat

addMessage

• addMessage(message): Chat

• Parameters

  • message: ChatCompletionMessageParam

  Returns Chat

addMessages

• addMessages(messages): Chat

• Parameters

  • messages: ChatCompletionMessageParam[]

  Returns Chat

addSystemMessage

• addSystemMessage(content): Chat

• Parameters

  • content: string

  Returns Chat

addUserMessage

• addUserMessage(content): Chat

• Parameters

  • content: string

  Returns Chat

appendSystemMessage

• appendSystemMessage(content): Chat

• Parameters

  • content: string

  Returns Chat

defineFunction

• defineFunction(name, description?): Chat

• Parameters

  • name: string
  • Optionaldescription: string

  Returns Chat

getFormattedResponse

• getFormattedResponse(name, type, description?): Promise<any>

• Parameters

  • name: string
  • type: any
  • Optionaldescription: string

  Returns Promise<any>

getFunctionCall

• getFunctionCall(functionName?): Promise<any>

• Parameters

  • OptionalfunctionName: string

  Returns Promise<any>

prompt

• prompt(functionName?, response_format?): Promise<ChatCompletion & {
      _request_id?: null | string;
  }>

• Parameters

  • OptionalfunctionName: string
  • Optionalresponse_format: ResponseFormatJSONSchema

  Returns Promise<ChatCompletion & {
      _request_id?: null | string;
  }>

setFunctionParameters

• setFunctionParameters(type): Chat

• Parameters

  • type: any

  Returns Chat

setModel

• setModel(model): Chat

• Parameters

  • model: string

  Returns Chat

setTools

• setTools(tools): void

• Parameters

  • tools: ChatCompletionTool[]

  Returns void