@egain/ai-agent-sdk API Reference - v0.1.1 / Portal

Interface: Portal

Represents a knowledge portal accessible to the user.

Portal

Table of contents

Properties

• id
• name
• description
• department

Properties

id

• id: string | number

Unique identifier (string or number)

Defined in

core/types/PortalTypes.ts:15

---

name

• name: string

Display name of the portal

Defined in

core/types/PortalTypes.ts:17

---

description

• Optional description: string

Optional description

Defined in

core/types/PortalTypes.ts:19

---

department

• Optional department: Object

Optional department association

Type declaration

Name	Type
id	number
name	string

Defined in

core/types/PortalTypes.ts:21