Contents

SKSummaryGetSentenceSummaryInfo(_:_:_:_:_:)

Gets detailed information about a body of text for constructing a custom sentence-based summary string.

Declaration

func SKSummaryGetSentenceSummaryInfo(_ summary: SKSummary!, _ numSentencesInSummary: CFIndex, _ outRankOrderOfSentences: UnsafeMutablePointer<CFIndex>!, _ outSentenceIndexOfSentences: UnsafeMutablePointer<CFIndex>!, _ outParagraphIndexOfSentences: UnsafeMutablePointer<CFIndex>!) -> CFIndex

Parameters

  • summary:

    The summarization object containing the text from which you want to build a summary.

  • numSentencesInSummary:

    The maximum number of sentences you want in the summary.

  • outRankOrderOfSentences:

    On input, a pointer to an array of CFIndex objects. On output, points to the previously allocated array, which now lists the summarization relevance rank of each sentence in the original text. The most important sentence gets a rank of 1. The array size must equal numSentencesInSummary, or else be NULL if you don’t want to get the rank orders.

  • outSentenceIndexOfSentences:

    On input, a pointer to an array of CFIndex objects. On output, points to the previously allocated array, which now contains the ordinal number for each sentence in the original text. Use the 1450287 Sksummarycopysentenceatindex function with one of these numbers to get the corresponding sentence. The array size must equal numSentencesInSummary, or else be NULL if you don’t want to get the ordinal numbers of the sentences.

  • outParagraphIndexOfSentences:

    On input, a pointer to an array of CFIndex objects. On output, points to the previously allocated array, which now contains the ordinal number for the paragraph that each corresponding sentence, referenced in outSentenceIndexOfSentences, appears in. The array size must equal numSentencesInSummary, or else be NULL if you don’t want to get the ordinal numbers of the sentences.

Return Value

The number of sentences in the summary.

See Also

Working With Summarization