Skip to main content

RequestSlot

Stentor API Reference


Stentor API Reference / stentor-models/src / RequestSlot

Interface: RequestSlot\<T>

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:32

Information for a slot coming in on the request.

Type Parameters​

T​

T = RequestSlotValues

Properties​

name​

name: string

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:38

The name of the slot, also used as the key in the RequestSlotMap.

For example, "FIRST_TEAM" or "Podcast", this is typically user defined.


value?​

optional value: T

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:47

The slot normalized value.

When leveraging synonyms, this will be the canonical value. If not then it is the same as the rawValue.

For example, "University of Virginia" or "Red Wine".


original?​

optional original: any

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:51

The original value provided by the NLU before normalization.


rawValue?​

optional rawValue: string

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:57

The raw spoken value.

For example, "cavaliers" or "red"


id?​

optional id: string

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:63

ID of the slot, if applicable.

For example, "UVA"


matchConfidence?​

optional matchConfidence: number

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:67

Confidence on the slot match. Range is between 0 - 1 where 1 is the highest confidence.


successfulMatch?​

optional successfulMatch: boolean

Defined in: packages/stentor-models/src/Request/IntentRequest.ts:73

If the entity resolution was successful or not.

See https://developer.amazon.com/docs/custom-skills/define-synonyms-and-ids-for-slot-type-values-entity-resolution.html#er-built-in-types