Skip to main content

Extract

ug-js-sdk

ug-js-sdk / Extract

Interface: Extract

Defined in: types/index.ts:916

Extract utility for extracting information from input.

Use this to extract specific information from user input or conversation context.

Example​

const nameExtractor: Extract = {
  type: 'extract',
  extract_prompt: 'Extract the person\'s name from the text',
}

Extends​

  • Utility

Properties​

debug?​

optional debug: boolean

Defined in: types/index.ts:859

Enable debug mode for this utility

Inherited from​

Utility.debug

type​

type: "extract"

Defined in: types/index.ts:917

The type of utility

Overrides​

Utility.type

extract_prompt​

extract_prompt: string

Defined in: types/index.ts:919

The prompt describing what to extract