Class CLClient

Hierarchy

CLClient

Index

Constructors

constructor

Properties

options

Constructors

constructor

new CLClient(options: ICLClientOptions): CLClient

- Defined in CLClient.ts:28
Parameters
- options: ICLClientOptions
Returns CLClient

Properties

Private options

options: ICLClientOptions

Methods

AddApp

AddApp(app: AppBase, query: string): Promise<string>

- Defined in CLClient.ts:181
Create a new application

Parameters
- app: AppBase
- query: string
Returns Promise<string>

ArchiveApp

ArchiveApp(appId: string): Promise<string>

- Defined in CLClient.ts:172
Archive an existing application Note: "deleting" an application doesn't destroy it, but rather archives it for a period (eg 30 days). During the archive period, the application can be restored with the next API call. At the end of the archive period, the application is destroyed.

Parameters
- appId: string
Returns Promise<string>

Private BuildURL

BuildURL(baseUri: string, apiPath: string, query?: undefined | string): string

- Defined in CLClient.ts:53
Parameters
- baseUri: string
- apiPath: string
- Optional query: undefined | string
Returns string

CopyApps

CopyApps(srcUserId: string, destUserId: string, appId: string, luisSubscriptionKey: string): Promise<string>

- Defined in CLClient.ts:160
Create a new application

Parameters
- srcUserId: string
- destUserId: string
- appId: string
- luisSubscriptionKey: string
Returns Promise<string>

EndSession

EndSession(appId: string, sessionId: string): Promise<string>

- Defined in CLClient.ts:317
End a session.

Parameters
- appId: string
- sessionId: string
Returns Promise<string>

EndTeach

EndTeach(appId: string, teachId: string, query: string): Promise<TrainResponse>

- Defined in CLClient.ts:386
Ends a teach. For Teach sessions, does NOT delete the associated trainDialog. To delete the associated trainDialog, call DELETE on the trainDialog.

Parameters
- appId: string
- teachId: string
- query: string
Returns Promise<TrainResponse>

GetApp

GetApp(appId: string): Promise<AppBase>

- Defined in CLClient.ts:138
Retrieve information about a specific application If the app ID isn't found in the set of (non-archived) apps, returns 404 error ("not found")

Parameters
- appId: string
Returns Promise<AppBase>

GetAppSource

GetAppSource(appId: string, packageId: string): Promise<AppDefinition>

- Defined in CLClient.ts:143
Parameters
- appId: string
- packageId: string
Returns Promise<AppDefinition>

GetApps

GetApps(query: string): Promise<AppList>

- Defined in CLClient.ts:154
Retrieve a list of (active) applications

Parameters
- query: string
Returns Promise<AppList>

GetEntities

GetEntities(appId: string, query?: undefined | string): Promise<EntityList>

- Defined in CLClient.ts:208
Retrieves definitions of ALL entities in the latest package (or the specified package, if provided). To retrieve just the IDs of all entities, see the GetEntityIds method

Parameters
- appId: string
- Optional query: undefined | string
Returns Promise<EntityList>

GetLogDialogs

GetLogDialogs(appId: string, packageIds: string[]): Promise<LogDialogList>

- Defined in CLClient.ts:221
Retrieves the contents of many/all logDialogs. To retrieve just a list of IDs of all logDialogs, see the GET GetLogDialogIds method.

Parameters
- appId: string
- packageIds: string[]
Returns Promise<LogDialogList>

GetSession

GetSession(appId: string, sessionId: string): Promise<Session>

- Defined in CLClient.ts:290
Gets information about a session

Parameters
- appId: string
- sessionId: string
Returns Promise<Session>

GetTrainDialog

GetTrainDialog(appId: string, trainDialogId: string, includeDefinitions?: boolean): Promise<TrainDialog>

- Defined in CLClient.ts:248
Retrieves information about a specific trainDialog in the current package (or the specified package, if provided)

Parameters
- appId: string
- trainDialogId: string
- Default value includeDefinitions: boolean = false
Returns Promise<TrainDialog>

LogDialogExtract

LogDialogExtract(appId: string, logDialogId: string, turnIndex: string, userInput: UserInput): Promise<ExtractResponse>

- Defined in CLClient.ts:228
Runs entity extraction (prediction).

Parameters
- appId: string
- logDialogId: string
- turnIndex: string
- userInput: UserInput
Returns Promise<ExtractResponse>

LuisAuthoringKey

LuisAuthoringKey(): string | undefined

- Defined in CLClient.ts:49
Returns string | undefined

Private MakeSessionURL

MakeSessionURL(apiPath: string, query?: undefined | string): string

- Defined in CLClient.ts:65
Parameters
- apiPath: string
- Optional query: undefined | string
Returns string

Private MakeURL

MakeURL(apiPath: string, query?: undefined | string): string

- Defined in CLClient.ts:61
Parameters
- apiPath: string
- Optional query: undefined | string
Returns string

PostAppSource

PostAppSource(appId: string, appDefinition: AppDefinition): Promise<void>

- Defined in CLClient.ts:148
Parameters
- appId: string
- appDefinition: AppDefinition
Returns Promise<void>

PublishApp

PublishApp(appId: string, tagName: string): Promise<PackageReference>

- Defined in CLClient.ts:189
Creates a new package tag

Parameters
- appId: string
- tagName: string
Returns Promise<PackageReference>

PublishProdPackage

PublishProdPackage(appId: string, packageId: string): Promise<string>

- Defined in CLClient.ts:195
Sets a package tags as the live version

Parameters
- appId: string
- packageId: string
Returns Promise<string>

SessionExtract

SessionExtract(appId: string, sessionId: string, userInput: UserInput): Promise<ExtractResponse>

- Defined in CLClient.ts:296
Runs entity extraction (prediction).

Parameters
- appId: string
- sessionId: string
- userInput: UserInput
Returns Promise<ExtractResponse>

SessionLogicResult

SessionLogicResult(appId: string, sessionId: string, actionId: string, actionResult: IActionResult): Promise<Object>

- Defined in CLClient.ts:311
Parameters
- appId: string
- sessionId: string
- actionId: string
- actionResult: IActionResult
Returns Promise<Object>

SessionScore

SessionScore(appId: string, sessionId: string, scorerInput: ScoreInput): Promise<ScoreResponse>

- Defined in CLClient.ts:306
Take a turn and returns chosen action

Parameters
- appId: string
- sessionId: string
- scorerInput: ScoreInput
Returns Promise<ScoreResponse>

StartSession

StartSession(appId: string, sessionCreateParams: SessionCreateParams): Promise<Session>

- Defined in CLClient.ts:283
Creates a new session and a corresponding logDialog

Parameters
- appId: string
- sessionCreateParams: SessionCreateParams
Returns Promise<Session>

StartTeach

StartTeach(appId: string, createTeachParams: CreateTeachParams): Promise<TeachResponse>

- Defined in CLClient.ts:329
Creates a new teaching session and a corresponding trainDialog

Parameters
- appId: string
- createTeachParams: CreateTeachParams
Returns Promise<TeachResponse>

TeachExtract

TeachExtract(appId: string, teachId: string, userInput: UserInput, filteredDialog: string | null): Promise<ExtractResponse>

- Defined in CLClient.ts:340
Runs entity extraction (prediction). If a more recent version of the package is available on the server, the session will first migrate to that newer version. This doesn't affect the trainDialog maintained.

Parameters
- appId: string
- teachId: string
- userInput: UserInput
- filteredDialog: string | null
Returns Promise<ExtractResponse>

TeachExtractFeedback

TeachExtractFeedback(appId: string, teachId: string, extractorStep: TrainExtractorStep): Promise<TeachResponse>

- Defined in CLClient.ts:355
Uploads a labeled entity extraction instance ie "commits" an entity extraction label, appending it to the teach session's trainDialog, and advancing the dialog. This may yield produce a new package.

Parameters
- appId: string
- teachId: string
- extractorStep: TrainExtractorStep
Returns Promise<TeachResponse>

TeachScore

TeachScore(appId: string, teachId: string, scorerInput: ScoreInput): Promise<ScoreResponse>

- Defined in CLClient.ts:366
Takes a turn and return distribution over actions. If a more recent version of the package is available on the server, the session will first migrate to that newer version. This doesn't affect the trainDialog maintained by the teaching session.

Parameters
- appId: string
- teachId: string
- scorerInput: ScoreInput
Returns Promise<ScoreResponse>

TeachScoreFeedback

TeachScoreFeedback(appId: string, teachId: string, scorerResponse: TrainScorerStep): Promise<TeachResponse>

- Defined in CLClient.ts:376
Uploads a labeled scorer step instance – ie "commits" a scorer label, appending it to the teach session's trainDialog, and advancing the dialog. This may yield produce a new package.

Parameters
- appId: string
- teachId: string
- scorerResponse: TrainScorerStep
Returns Promise<TeachResponse>

TrainDialogExtract

TrainDialogExtract(appId: string, trainDialogId: string, turnIndex: string, userInput: UserInput): Promise<ExtractResponse>

- Defined in CLClient.ts:255
Runs entity extraction (prediction).

Parameters
- appId: string
- trainDialogId: string
- turnIndex: string
- userInput: UserInput
Returns Promise<ExtractResponse>

TrainDialogValidateTextVariation

TrainDialogValidateTextVariation(appId: string, trainDialogId: string, textVariation: TextVariation, filteredDialog: string): Promise<null>

- Defined in CLClient.ts:271
Returns a 409 if text variation conflicts with existing labels, otherwise 200 filteredDialog is dialog to ignore when checking for conflicts

Parameters
- appId: string
- trainDialogId: string
- textVariation: TextVariation
- filteredDialog: string
Returns Promise<null>

ValidationError

ValidationError(): string | null

- Defined in CLClient.ts:38
Returns string | null

Private send

send<T>(method: HTTP_METHOD, url: string, body?: any): Promise<T>

- Defined in CLClient.ts:97
Type parameters
- T
Parameters
- method: HTTP_METHOD
- url: string
- Optional body: any
Returns Promise<T>

Generated using TypeDoc