@humanlayer/sdk/src/models.ts

typescript client for humanlayer.dev

type FunctionCallStatus = {
  requested_at: Date
  responded_at?: Date
  approved?: boolean
  comment?: string
  reject_option_name?: string
  slack_message_ts?: string
}

type SlackContactChannel = {
  // the slack channel or user id to contact
  channel_or_user_id: string
  // the context about the channel or user to contact
  context_about_channel_or_user?: string
  // the bot token to use to contact the channel or user
  bot_token?: string
  experimental_slack_blocks?: boolean
  // the thread ts to use for sending the request in a thread
  thread_ts?: string
}

type SMSContactChannel = {
  phone_number: string
  context_about_user?: string
}

type WhatsAppContactChannel = {
  phone_number: string
  context_about_user?: string
}

type EmailContactChannel = {
  address: string
  context_about_user?: string

  additional_recipients?: EmailRecipient[]

  experimental_subject_line?: string
  experimental_in_reply_to_message_id?: string
  experimental_references_message_id?: string

  // If provided, this Jinja2 template will be used to render the email body
  template?: string
}

type EmailRecipient = {
  address: string
  context_about_user?: string
  field: 'to' | 'cc' | 'bcc'
}

type ContactChannel = {
  slack?: SlackContactChannel
  sms?: SMSContactChannel
  whatsapp?: WhatsAppContactChannel
  email?: EmailContactChannel
}

type ResponseOption = {
  name: string
  title?: string
  description?: string
  prompt_fill?: string
  interactive?: boolean
}

type FunctionCallSpec = {
  // the function name to call
  fn: string
  // the function arguments
  kwargs: Record<string, any>
  // the contact channel to use to contact the human
  channel?: ContactChannel
  reject_options?: ResponseOption[]
  // Optional state to be preserved across the request lifecycle
  state?: Record<string, any>
}

type FunctionCall = {
  // the run id
  run_id: string
  call_id: string
  spec: FunctionCallSpec
  status?: FunctionCallStatus
}

type Escalation = {
  escalation_msg: string
  additional_recipients?: EmailRecipient[]
  channel?: ContactChannel
}

type HumanContactSpec = {
  // the message to send to the human
  msg: string
  // the contact channel to use to contact the human
  channel?: ContactChannel
  response_options?: ResponseOption[]
  // Optional state to be preserved across the request lifecycle
  state?: Record<string, any>
}

type HumanContactStatus = {
  requested_at?: Date
  responded_at?: Date
  // the response from the human
  response?: string
  // the name of the selected response option
  response_option_name?: string
}

type HumanContact = {
  // the run id
  run_id: string
  // the call id
  call_id: string
  // the spec for the human contact
  spec: HumanContactSpec
  status?: HumanContactStatus
}

export {
  SlackContactChannel,
  SMSContactChannel,
  WhatsAppContactChannel,
  EmailContactChannel,
  EmailRecipient,
  ContactChannel,
  ResponseOption,
  FunctionCallSpec,
  FunctionCallStatus,
  FunctionCall,
  Escalation,
  HumanContactSpec,
  HumanContactStatus,
  HumanContact,
}