1. SummaryParams¶
- class select_ai.summary.SummaryParams(min_words: int | None = None, max_words: int | None = None, summary_style: Style | None = None, chunk_processing_method: ChunkProcessingMethod | None = None, extractiveness_level: ExtractivenessLevel | None = None)¶
Customize summary generation using these parameters
- Parameters:
min_words (int) – approximate minimum number of words the generated summary is expected to contain.
max_words (int) – approximate maximum number of words the generated summary is expected to contain.
summary_style (select_ai.summary.Style) – Specifies the format style for the summary
chunk_processing_method (select_ai.summary.ChunkProcessingMethod) – When the text exceeds the token limit that the LLM can process, it must be split into manageable chunks
extractiveness_level (select_ai.summary.ExtractivenessLevel) – Determines how closely the summary follows the original wording of the input
2. ChunkProcessingMethod¶
- class select_ai.summary.ChunkProcessingMethod(*values)¶
When the text exceeds the token limit that the LLM can process, it must be split into manageable chunks. This parameter enables you to choose the method for processing these chunks - ChunkProcessingMethod.ITERATIVE_REFINEMENT - ChunkProcessingMethod.MAP_REDUCE
3. ExtractivenessLevel¶
- class select_ai.summary.ExtractivenessLevel(*values)¶
Determines how closely the summary follows the original wording of the input. It controls the degree to which the model extracts versus rephrases it. The following are the options: - ExtractivenessLevel.LOW - ExtractivenessLevel.MEDIUM - ExtractivenessLevel.HIGH
4. SummaryStyle¶
- class select_ai.summary.Style(*values)¶
Specifies the format style for the summary. The following are the available summary format options: - Style.PARAGRAPH - the summary is presented in one or more paragraphs. - Style.LIST - the summary is a list of key points from the text.