Skip to main content

StudioService

Stentor API Reference

Stentor API Reference / stentor-service-studio/src / StudioService

Class: StudioService

Defined in: packages/stentor-service-studio/src/StudioService.ts:46

Implements​

  • HandlerService
  • KnowledgeBaseService

Constructors​

Constructor​

new StudioService(props?): StudioService

Defined in: packages/stentor-service-studio/src/StudioService.ts:53

Parameters​

props?​

StudioServiceProps

Returns​

StudioService

Methods​

getAll()​

getAll(): Promise\<Handler\<Content, Data, Forward, Redirect>[]>

Defined in: packages/stentor-service-studio/src/StudioService.ts:92

Returns​

Promise\<Handler\<Content, Data, Forward, Redirect>[]>

get()​

get(id): Promise\<undefined> | Promise\<Handler\<Content, Data, Forward, Redirect>>

Defined in: packages/stentor-service-studio/src/StudioService.ts:117

Get the handler by ID.

Parameters​

id​

string | { intentId: string; }

Returns​

Promise\<undefined> | Promise\<Handler\<Content, Data, Forward, Redirect>>

Implementation of​

HandlerService.get

query()​

query(query, options?): Promise\<KnowledgeBaseResult>

Defined in: packages/stentor-service-studio/src/StudioService.ts:162

Queries both /cms/search & /cms/faq/query to return KnowledgeBaseResult.

Parameters​

query​

string

options?​
controller?​

AbortController

filters?​

{[key: string]: string; }

Returns​

Promise\<KnowledgeBaseResult>

Implementation of​

KnowledgeBaseService.query

search(query, options?): Promise\<Pick\<KnowledgeBaseResult, "documents" | "suggested">>

Defined in: packages/stentor-service-studio/src/StudioService.ts:202

Search a knowledge base.

Calls /cms/search endpoint.

Parameters​

query​

string

The query to search

options?​
controller?​

AbortController

filters?​

{[key: string]: string; }

Returns​

Promise\<Pick\<KnowledgeBaseResult, "documents" | "suggested">>

faq()​

faq(query, options?): Promise\<KnowledgeBaseFAQResult>

Defined in: packages/stentor-service-studio/src/StudioService.ts:261

Find a FAQ match based on the query.

The results are already sorted by relevancy.

Parameters​

query​

string

options?​
controller?​

AbortController

Returns​

Promise\<KnowledgeBaseFAQResult>

Implementation of​

KnowledgeBaseService.faq

rag()​

rag(query, options): Promise\<KnowledgeBaseGenerated>

Defined in: packages/stentor-service-studio/src/StudioService.ts:340

Beta

Retrieval Augmented Generation Response

Parameters​

query​

string

options​
temperature?​

number

api?​

"retrieve" | "query"

controller?​

AbortController

filters?​

{[key: string]: string; }

Returns​

Promise\<KnowledgeBaseGenerated>

Implementation of​

KnowledgeBaseService.rag

putEvents()​

putEvents(events): Promise\<void>

Defined in: packages/stentor-service-studio/src/StudioService.ts:407

Parameters​

events​

Event\<any>[]

Returns​

Promise\<void>