Skip to main content

ISummarizerEvents Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

/** @sealed */
export interface ISummarizerEvents extends IEvent

Extends: IEvent

Call Signatures​

CallSignature Alerts Description
(event: "summarize", listener: (props: ISummarizeEventProps & ISummarizerObservabilityProps) => void): any Alpha
(event: "summarizeAllAttemptsFailed", listener: (props: Omit<ISummarizeEventProps, "result"> & ISummarizerObservabilityProps) => void): any Alpha
(event: "summarizerStop", listener: (props: { stopReason: SummarizerStopReason; error?: any; } & ISummarizerObservabilityProps) => void): any Alpha
(event: "summarizerStart", listener: (props: { onBehalfOf: string; } & ISummarizerObservabilityProps) => void): any Alpha
(event: "summarizerStartupFailed", listener: (props: { reason: SummarizerStopReason; } & ISummarizerObservabilityProps) => void): any Alpha

Call Signature Details​

(event: "summarize", listener: (props: ISummarizeEventProps & ISummarizerObservabilityProps) => void): any​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

(event: "summarize", listener: (props: ISummarizeEventProps & ISummarizerObservabilityProps) => void): any;

(event: "summarizeAllAttemptsFailed", listener: (props: Omit<ISummarizeEventProps, "result"> & ISummarizerObservabilityProps) => void): any​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

(event: "summarizeAllAttemptsFailed", listener: (props: Omit<ISummarizeEventProps, "result"> & ISummarizerObservabilityProps) => void): any;

(event: "summarizerStop", listener: (props: { stopReason: SummarizerStopReason; error?: any; } & ISummarizerObservabilityProps) => void): any​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

(event: "summarizerStop", listener: (props: {
        stopReason: SummarizerStopReason;
        error?: any;
    } & ISummarizerObservabilityProps) => void): any;

(event: "summarizerStart", listener: (props: { onBehalfOf: string; } & ISummarizerObservabilityProps) => void): any​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

(event: "summarizerStart", listener: (props: {
        onBehalfOf: string;
    } & ISummarizerObservabilityProps) => void): any;

(event: "summarizerStartupFailed", listener: (props: { reason: SummarizerStopReason; } & ISummarizerObservabilityProps) => void): any​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

(event: "summarizerStartupFailed", listener: (props: {
        reason: SummarizerStopReason;
    } & ISummarizerObservabilityProps) => void): any;