Module andiskills/lib/interfaces/v3

Index

Type aliases

Type aliases

ConfigGroup

ConfigGroup: ConfigMetadata & { itemType: "group"; keys: ConfigKey[] }

ConfigKey

ConfigKey: { default?: unknown; itemType: "key"; required?: boolean } & ConfigMetadata & { dataType: "number" | "text" | "date" | "boolean" | "secret" } | { dataType: "localization"; overrideLocales: string[] } | { dataType: "option"; multiSelect?: boolean; options: ConfigOption[] }

ConfigMetadata

ConfigMetadata: { description?: string; displayName: string; name: string }

Type declaration

  • Optional description?: string
  • displayName: string
  • name: string

ConfigOption

ConfigOption: { key: string; type: ConfigOptionType }

Type declaration

ConfigOptionType

ConfigOptionType: "inline" | "lookup"

ConfigProperties

ConfigProperties: Record<string, ConfigValue>

ConfigSchema

ConfigSchema: ConfigSchemaItem[]

ConfigSchemaItem

ConfigSchemaItem: ConfigKey | ConfigGroup

ConfigValue

ConfigValue: SimpleConfigValue | LocalizationConfigValue | OptionConfigValue | ConfigValueGroup[]

ConfigValueGroup

ConfigValueGroup: { name?: string; values: Record<string, ConfigValue> }

Type declaration

  • Optional name?: string
  • values: Record<string, ConfigValue>

LocalizationConfigKey

LocalizationConfigKey: Extract<ConfigKey, { dataType: "localization" }>

LocalizationConfigValue

LocalizationConfigValue: Record<string, string>

LocalizationString

LocalizationString: ConfigMetadata & { overrideLocales: string[] }

OptionConfigKey

OptionConfigKey: Extract<ConfigKey, { dataType: "option" }>

OptionConfigValue

OptionConfigValue: string[]

Resource

Resource: { path: string; type: ResourceType }

Type declaration

ResourceType

ResourceType: "localization" | "ts" | "js"

SimpleConfigKey

SimpleConfigKey: Extract<ConfigKey, { dataType: "number" | "text" | "date" | "boolean" | "secret" }>

SimpleConfigValue

SimpleConfigValue: number | string | Date | boolean

SkillMetadata

SkillMetadata: { accessesExternalEndpoints: boolean; andiSkillsKitVersion: string; applicationId: string; availableInContexts: string[]; configSchema: ConfigSchema; contextId: string; created: string; dataSets: IDataSet[]; dependencies: {}; description: string; eventSubscriptions?: string[]; exposeSkillRESTEndpoint: boolean; integrations?: IntegrationDefinition; isConversationalSkill: boolean; lastUpdated: string; locales: string[]; localization: LocalizationString[]; name: string; nlpSettings?: INlpSettings; ownerOrganizationId: string; ownerUserId: string; requiresInitialization: boolean; resources: Resource[]; skillId: string; skillOverrides: string[]; skillVersionId: string; tag?: string; typescriptVersion?: string; version: number | string }

Skill Metadata shape for andiSkillsKitVersion = 3.x

Type declaration

  • accessesExternalEndpoints: boolean
  • andiSkillsKitVersion: string
  • applicationId: string
  • availableInContexts: string[]
  • configSchema: ConfigSchema
  • contextId: string
  • created: string
  • dataSets: IDataSet[]
  • dependencies: {}
    • [property: string]: string
  • description: string
  • Optional eventSubscriptions?: string[]
  • exposeSkillRESTEndpoint: boolean
  • Optional integrations?: IntegrationDefinition
  • isConversationalSkill: boolean
  • lastUpdated: string
  • locales: string[]
  • localization: LocalizationString[]
  • name: string
  • Optional nlpSettings?: INlpSettings
  • ownerOrganizationId: string
  • ownerUserId: string
  • requiresInitialization: boolean
  • resources: Resource[]
  • skillId: string
  • skillOverrides: string[]
  • skillVersionId: string
  • Optional tag?: string
  • Optional typescriptVersion?: string
  • version: number | string

Generated using TypeDoc