NLURequestProps

Stentor API Reference

---

Stentor API Reference / stentor-models/src / NLURequestProps

Interface: NLURequestProps

Defined in: packages/stentor-models/src/NLU/NLUService.ts:23

Properties

locale?

optional locale?: string

Defined in: packages/stentor-models/src/NLU/NLUService.ts:27

Optional locale to request, defaults to "en"

---

userId?

optional userId?: string

Defined in: packages/stentor-models/src/NLU/NLUService.ts:31

Optional userId to pass with the request

---

sessionId?

optional sessionId?: string

Defined in: packages/stentor-models/src/NLU/NLUService.ts:35

Optional sessionId to pass with the request

---

channel?

optional channel?: string

Defined in: packages/stentor-models/src/NLU/NLUService.ts:39

Optional channel information

---

platform?

optional platform?: string

Defined in: packages/stentor-models/src/NLU/NLUService.ts:43

Optional platform information.

---

activeContext?

optional activeContext?: ActiveContext[]

Defined in: packages/stentor-models/src/NLU/NLUService.ts:48

Optional active context to pass with the request, used to weight certain intents.

---

requestAttributes?

optional requestAttributes?: Record<string, string>

Defined in: packages/stentor-models/src/NLU/NLUService.ts:52

Optional request attributes.

---

transcript?

optional transcript?: Message[]

Defined in: packages/stentor-models/src/NLU/NLUService.ts:56

Current session transcript

---

session?

optional session?: SessionStore

Defined in: packages/stentor-models/src/NLU/NLUService.ts:60

Optional session store

---

filters?

optional filters?: object

Defined in: packages/stentor-models/src/NLU/NLUService.ts:64

Optional filters for knowledge base service calls

Index Signature

[key: string]: string