GrapeCity.Documents.Pdf.AI.OpenAIDocumentAssistantBase.GetSummary
GetSummary Method
GetSummary(GcPdfDocument, RecognitionAlgorithm, OutputRange, CancellationToken)
Creates a summary of the specified GcPdfDocument.
Declaration
public Task<string> GetSummary(GcPdfDocument doc, RecognitionAlgorithm recognitionAlgorithm = RecognitionAlgorithm.Advanced, OutputRange pageRange = null, CancellationToken cancellationToken = default)Public Function GetSummary(doc As GcPdfDocument, Optional recognitionAlgorithm As RecognitionAlgorithm = RecognitionAlgorithm.Advanced, Optional pageRange As OutputRange = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)Parameters
| Type | Name | Description |
|---|---|---|
| GcPdfDocument | doc | The GcPdfDocument object to analyze. |
| RecognitionAlgorithm | recognitionAlgorithm | The RecognitionAlgorithm to use when analyzing the document. Defaults to Advanced. |
| OutputRange | pageRange | The range of pages to analyze. If null, all pages are included. Defaults to null. |
| CancellationToken | cancellationToken | A token that can be used to cancel the operation. Defaults to None. |
Returns
| Type | Description |
|---|---|
| Task<string> | A task that represents the summary as a plain text string. |