Interface AnalysisCallback

Callback interface for the analyze method.

interface AnalysisCallback {
    onComplete?: (response: AnalysisResponse) => void;
    onError?: (error: Event) => void;
    onPartial?: (response: AnalysisResponse) => void;
}

Index

Properties

onComplete? onError? onPartial?

Properties

`Optional`onComplete

onComplete?: (response: AnalysisResponse) => void

Called when the complete analysis response is received.

Type declaration

- (response: AnalysisResponse): void
- Parameters
  - response: AnalysisResponse
    The complete analysis response.
  Returns void

`Optional`onError

onError?: (error: Event) => void

Called when an error occurs during the analysis.

Type declaration

- (error: Event): void
- Parameters
  - error: Event
    The error event.
  Returns void

`Optional`onPartial

onPartial?: (response: AnalysisResponse) => void

Called when a partial analysis response is received.

Type declaration

- (response: AnalysisResponse): void
- Parameters
  - response: AnalysisResponse
    The partial analysis response.
  Returns void