MediaPipeTasksText Framework Reference

TextSummarizer

class TextSummarizer : NSObject

Performs summarization on text using a LiteRT-LM model asset bundle.

  • Creates a new instance of TextSummarizer from an absolute path to a model asset bundle.

    Declaration

    Swift

    convenience init(modelPath: String) throws

    Parameters

    modelPath

    Absolute path to a model file on the device.

    Return Value

    A new instance of TextSummarizer.

  • Creates a new instance of TextSummarizer from the given TextSummarizerOptions.

    Declaration

    Swift

    init(options: TextSummarizerOptions) throws

    Parameters

    options

    The TextSummarizerOptions used to configure the summarizer.

    Return Value

    A new instance of TextSummarizer.

  • Performs summarization on the input text.

    Declaration

    Swift

    func summarize(text: String) throws -> TextSummarizerResult

    Parameters

    text

    The String on which summarization is to be performed.

    Return Value

    A TextSummarizerResult containing the complete summary.

  • Performs summarization on the input text and delivers incremental chunks via the completion handler.

    Declaration

    Swift

    func summarizeStreaming(text: String, completion: @escaping (TextSummarizerResult?, Error?) -> Void) throws

    Parameters

    text

    The input text to summarize.

    completion

    Callback invoked with incremental summarization chunks.

  • Shuts down the TextSummarizer when all work is done.

    Declaration

    Swift

    func close() throws