Skip to content

Commit 6d327cc

Browse files
committed
Canged AI title and some formatting
1 parent 1df6421 commit 6d327cc

File tree

6 files changed

+62
-53
lines changed

6 files changed

+62
-53
lines changed

_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -215,8 +215,8 @@ navigation:
215215
libraries/radpdfprocessing/features/embedded-file-streams:
216216
title: Embedded File Streams
217217
position: 5
218-
libraries/radpdfprocessing/features/ai-document-analysis:
219-
title: AI Document Analysis
218+
libraries/radpdfprocessing/features/gen-ai-powered-document-insights:
219+
title: GenAI-powered Document Insights
220220
position: 6
221221
libraries/radpdfprocessing/model/interactive-forms:
222222
title: Interactive Forms

libraries/radpdfprocessing/features/ai-document-analysis/complete-context-question-processor.md renamed to libraries/radpdfprocessing/features/gen-ai-powered-document-insights/complete-context-question-processor.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: CompleteContextQuestionProcessor
33
page_title: CompleteContextQuestionProcessor
4-
slug: radpdfprocessing-features-ai-document-analysis-complete-context-question-processor
4+
slug: radpdfprocessing-features-gen-ai-powered-document-insights-complete-context-question-processor
55
tags: ai, document, analysis, question, processor, complete, context
66
published: True
77
position: 4
@@ -20,23 +20,23 @@ table th:nth-of-type(2) {
2020

2121
# CompleteContextQuestionProcessor
2222

23-
The **CompleteContextQuestionProcessor** class enables you to ask questions about a PDF document and receive answers based on the entire document content. Unlike [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%}), this processor sends the complete document text to the AI model, which is suitable for smaller documents or when you need to ensure that the AI model has access to all the information in the document. This class inherits from the abstract **AIProcessorBase** class, which provides common functionality for all AI processors.
23+
The **CompleteContextQuestionProcessor** class enables you to ask questions about a PDF document and receive answers based on the entire document content. This processor sends the complete document text to the AI model, which is suitable for smaller documents or when you need to ensure that the AI model has access to all the information in the document. This class inherits from the abstract **AIProcessorBase** class, which provides common functionality for all AI processors.
2424

2525
## When to Use CompleteContextQuestionProcessor
2626

2727
The **CompleteContextQuestionProcessor** is ideal for the following scenarios:
2828

2929
1. **Small Documents**: When the document is small enough to fit within the token limit of the AI model.
3030
2. **Holistic Understanding**: When the question requires understanding the entire document context.
31-
3. **Simplicity**: When you don't need the advanced embedding functionality of **PartialContextQuestionProcessor**.
31+
3. **Simplicity**: When you don't need the advanced embedding functionality of [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%}).
3232

3333
However, if you're working with larger documents or want to optimize token usage, you should use the [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%}#when-to-use-partialcontextquestionprocessor) instead.
3434

3535
## Public API
3636

3737
|Property|Description|
3838
|---|---|
39-
|**Settings**|Gets the settings for the AI question-answering process. Returns **CompleteContextProcessorSettings**.|
39+
|**Settings**|Gets the settings for the AI question-answering process. Returns [CompleteContextProcessorSettings]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%}#completectextprocessorsettings).|
4040

4141
|Method|Description|
4242
|---|---|
@@ -169,7 +169,7 @@ private bool IsDocumentSuitableForCompleteContext(RadFixedDocument document, int
169169

170170
## See Also
171171

172-
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-ai-document-analysis-overview%})
173-
* [Prerequisites]({%slug radpdfprocessing-features-ai-document-analysis-prerequisites%})
174-
* [SummarizationProcessor]({%slug radpdfprocessing-features-ai-document-analysis-summarization-processor%})
175-
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%})
172+
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-overview%})
173+
* [Prerequisites]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-prerequisites%})
174+
* [SummarizationProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-summarization-processor%})
175+
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-partial-context-question-processor%})

libraries/radpdfprocessing/features/ai-document-analysis/overview.md renamed to libraries/radpdfprocessing/features/gen-ai-powered-document-insights/overview.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: Overview
33
page_title: Overview
4-
slug: radpdfprocessing-features-ai-document-analysis-overview
5-
tags: ai, document, analysis, overview, pdf, processing
4+
slug: radpdfprocessing-features-gen-ai-powered-document-insights-overview
5+
tags: ai, document, analysis, overview, pdf, processing, genai, powered, insights
66
published: True
77
position: 0
88
---
99

10-
# AI Document Analysis Overview
10+
# GenAI-powered Document Insights Overview
1111

12-
The AI Document Analysis feature enables you to easily extract insights from PDF documents using Large Language Models (LLMs). This functionality allows you to summarize document content and ask questions about the document, with the AI providing relevant answers based on the document's content.
12+
The GenAI-powered Document Insights feature enables you to easily extract insights from PDF documents using Large Language Models (LLMs). This functionality allows you to summarize document content and ask questions about the document, with the AI providing relevant answers based on the document's content.
1313

14-
The AI Document Analysis feature includes three main components:
14+
The GenAI-powered Document Insights feature includes three main components:
1515

1616
* **[SummarizationProcessor]({%slug radpdfprocessing-features-ai-document-analysis-summarization-processor%})**: Generates concise summaries of PDF documents.
1717
* **[CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%})**: Answers questions by providing the entire document content to the AI model.
@@ -26,9 +26,9 @@ The AI Document Analysis feature includes three main components:
2626

2727
## Complete Example
2828

29-
The following example demonstrates how to use the AI Document Analysis functionality to summarize a PDF document and ask questions about it:
29+
The following example demonstrates how to use the GenAI-powered Document Insights functionality to summarize a PDF document and ask questions about it:
3030

31-
#### __[C#] Example 1: Using AI Document Analysis__
31+
#### __[C#] Example 1: Using GenAI-powered Document Insights__
3232

3333
```csharp
3434
private async void ProcessPdfWithAI()
@@ -119,7 +119,7 @@ When you run this code, the AI will process your document, generate a summary, a
119119

120120
## See Also
121121

122-
* [Prerequisites]({%slug radpdfprocessing-features-ai-document-analysis-prerequisites%})
123-
* [SummarizationProcessor]({%slug radpdfprocessing-features-ai-document-analysis-summarization-processor%})
124-
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%})
125-
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%})
122+
* [Prerequisites]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-prerequisites%})
123+
* [SummarizationProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-summarization-processor%})
124+
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-partial-context-question-processor%})
125+
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-complete-context-question-processor%})

libraries/radpdfprocessing/features/ai-document-analysis/partial-context-question-processor.md renamed to libraries/radpdfprocessing/features/gen-ai-powered-document-insights/partial-context-question-processor.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: PartialContextQuestionProcessor
33
page_title: PartialContextQuestionProcessor
4-
slug: radpdfprocessing-features-ai-document-analysis-partial-context-question-processor
4+
slug: radpdfprocessing-features-gen-ai-powered-document-insights-partial-context-question-processor
55
tags: ai, document, analysis, question, processor, partial, context, embeddings
66
published: True
77
position: 3
@@ -11,19 +11,19 @@ table, th, td {
1111
border: 1px solid;
1212
}
1313
table th:first-of-type {
14-
width: 20%;
14+
width: 65%;
1515
}
1616
table th:nth-of-type(2) {
17-
width: 15%;
17+
width: 10%;
1818
}
1919
table th:nth-of-type(3) {
20-
width: 65%;
20+
width: 25%;
2121
}
2222
</style>
2323

2424
# PartialContextQuestionProcessor
2525

26-
The **PartialContextQuestionProcessor** class enables you to ask questions about a PDF document and receive answers based on the most relevant parts of the document content. Unlike [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%}), this processor uses embeddings to identify and send only the relevant portions of the document to the AI model, making it more efficient for token usage and more suitable for large documents. This class inherits from the abstract **AIProcessorBase** class, which provides common functionality for all AI processors.
26+
The **PartialContextQuestionProcessor** class enables you to ask questions about a PDF document and receive answers based on the most relevant parts of the document content. This processor uses embeddings to identify and send only the relevant portions of the document to the AI model, making it more efficient for token usage and more suitable for large documents. This class inherits from the abstract **AIProcessorBase** class, which provides common functionality for all AI processors.
2727

2828
## When to Use PartialContextQuestionProcessor
2929

@@ -38,7 +38,7 @@ The **PartialContextQuestionProcessor** is ideal for the following scenarios:
3838
|Constructor|Platform|Description|
3939
|---|---|---|
4040
|**PartialContextQuestionProcessor(IChatClient chatClient, int modelMaxInputTokenLimit, ISimpleTextDocument document)**|.NET 7+|Creates an instance with built-in embeddings storage|
41-
|**PartialContextQuestionProcessor(IChatClient chatClient, IEmbeddingsStorage embeddingsStorage, int modelMaxInputTokenLimit, ISimpleTextDocument document)**|All platforms|Creates an instance with custom embeddings storage|
41+
|**PartialContextQuestionProcessor(IChatClient chatClient, IEmbeddingsStorage embeddingsStorage, int modelMaxInputTokenLimit, ISimpleTextDocument document)**|Any|Creates an instance with custom embeddings storage|
4242

4343
> The .NET 7+ constructor uses **DefaultEmbeddingsStorage** internally, while the cross-platform constructor requires a custom implementation of **IEmbeddingsStorage** as shown in the [Prerequisites]({%slug radpdfprocessing-features-ai-document-analysis-prerequisites%}#iembeddingsstorage-setup-for-net-standard-and-net-framework).
4444
@@ -283,7 +283,7 @@ using (PartialContextQuestionProcessor processor =
283283

284284
## See Also
285285

286-
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-ai-document-analysis-overview%})
287-
* [Prerequisites]({%slug radpdfprocessing-features-ai-document-analysis-prerequisites%})
288-
* [SummarizationProcessor]({%slug radpdfprocessing-features-ai-document-analysis-summarization-processor%})
289-
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%})
286+
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-overview%})
287+
* [Prerequisites]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-prerequisites%})
288+
* [SummarizationProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-summarization-processor%})
289+
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-complete-context-question-processor%})

libraries/radpdfprocessing/features/ai-document-analysis/prerequisites.md renamed to libraries/radpdfprocessing/features/gen-ai-powered-document-insights/prerequisites.md

+25-16
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
---
22
title: Prerequisites
33
page_title: Prerequisites
4-
slug: radpdfprocessing-features-ai-document-analysis-prerequisites
4+
slug: radpdfprocessing-features-gen-ai-powered-document-insights-prerequisites
55
tags: ai, document, analysis, prerequisites, setup, installation
66
published: True
77
position: 1
88
---
99
<style>
1010
table, th, td {
11-
border: 1px solid;
11+
border: 1px solid;
1212
}
13-
table th:first-of-type {
14-
width: 50%;
13+
/* First table with two columns */
14+
table:nth-of-type(1) th:first-of-type {
15+
width: 50%;
16+
}
17+
table:nth-of-type(1) th:nth-of-type(2) {
18+
width: 50%;
19+
}
20+
/* Second table with three columns */
21+
table:nth-of-type(2) th {
22+
width: 33.33%;
1523
}
16-
table th:nth-of-type(2) {
17-
width: 50%;
18-
}
1924
</style>
2025

21-
# AI Document Analysis Prerequisites
22-
This article explains the requirements for using the AI Document Analysis functionality in the [RadPdfProcessing library]({%slug radpdfprocessing-overview%}).
26+
# GenAI-powered Document Insights Prerequisites
27+
This article explains the requirements for using the GenAI-powered Document Insights functionality in the [RadPdfProcessing library]({%slug radpdfprocessing-overview%}).
2328

2429
## Required Assemblies
2530

26-
In addition to the [standard RadPdfProcessing assemblies]({%slug radpdfprocessing-getting-started%}#assembly-references), you will need to reference the following assemblies to use the AI Document Analysis features:
31+
In addition to the [standard RadPdfProcessing assemblies]({%slug radpdfprocessing-getting-started%}#assembly-references), you will need to reference the following assemblies to use the GenAI-powered Document Insights features:
2732

2833
|.NET Framework|.NET Standard-compatible|
2934
|---|---|
@@ -44,7 +49,11 @@ Additionally, you'll need a package for your specific AI provider:
4449

4550
## AI Provider Setup
4651

47-
Before using the AI Document Analysis functionality, you need to set up an AI provider.
52+
Before using the GenAI-powered Document Insights functionality, you need to set up an AI provider.
53+
54+
| [Azure OpenAI Setup](#azure-openai-setup) | [OpenAI Setup](#openai-setup) | [Ollama Setup (Local AI)](#ollama-setup-local-ai) |
55+
|---|---|---|
56+
| Uses the Azure OpenAI service, which provides enterprise-grade security, compliance, and regional availability for OpenAI models. | Uses direct access to OpenAI's models through their API service. Suitable for general development scenarios. | Runs AI models locally on your machine. Useful for development or working with sensitive data where privacy is important. |
4857

4958
### Azure OpenAI Setup
5059

@@ -118,7 +127,7 @@ int maxTokenLimit = 4096; // Adjust based on your model
118127

119128
## IEmbeddingsStorage Setup for .NET Standard and .NET Framework
120129

121-
When using the **PartialContextQuestionProcessor** in .NET Standard or .NET Framework, you need to provide an implementation of the **IEmbeddingsStorage** interface. This is required for the functionality described in the [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%}#constructors-and-platform-support) section.
130+
When using the [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%}#constructors-and-platform-support) in .NET Standard or .NET Framework, you need to provide an implementation of the **IEmbeddingsStorage** interface.
122131

123132
For this sample Ollama implementation, you'll need to add references to the following NuGet packages:
124133
* **LangChain.Ollama**
@@ -184,7 +193,7 @@ internal class OllamaEmbeddingsStorage : IEmbeddingsStorage
184193

185194
## See Also
186195

187-
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-ai-document-analysis-overview%})
188-
* [SummarizationProcessor]({%slug radpdfprocessing-features-ai-document-analysis-summarization-processor%})
189-
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%})
190-
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%})
196+
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-overview%})
197+
* [SummarizationProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-summarization-processor%})
198+
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-partial-context-question-processor%})
199+
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-complete-context-question-processor%})

libraries/radpdfprocessing/features/ai-document-analysis/summarization-processor.md renamed to libraries/radpdfprocessing/features/gen-ai-powered-document-insights/summarization-processor.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SummarizationProcessor
33
page_title: SummarizationProcessor
4-
slug: radpdfprocessing-features-ai-document-analysis-summarization-processor
4+
slug: radpdfprocessing-features-gen-ai-powered-document-insights-summarization-processor
55
tags: ai, document, analysis, summarization, processor, summary
66
published: True
77
position: 2
@@ -40,7 +40,7 @@ The **SummarizationProcessor** class enables you to generate concise summaries o
4040

4141
## SummarizationProcessorSettings
4242

43-
The **ummarizationProcessorSettings** class provides configuration options for the summarization process:
43+
The **SummarizationProcessorSettings** class provides configuration options for the summarization process:
4444

4545
* **PromptAddition**: Gets or sets an addition for the prompt used for summarization. It can be used for clarification purposes.
4646

@@ -163,7 +163,7 @@ summarizationProcessor.SummaryResourcesCalculated += (object sender, SummaryReso
163163
```
164164
## See Also
165165

166-
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-ai-document-analysis-overview%})
167-
* [Prerequisites]({%slug radpdfprocessing-features-ai-document-analysis-prerequisites%})
168-
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-partial-context-question-processor%})
169-
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-ai-document-analysis-complete-context-question-processor%})
166+
* [AI Document Analysis Overview]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-overview%})
167+
* [Prerequisites]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-prerequisites%})
168+
* [PartialContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-partial-context-question-processor%})
169+
* [CompleteContextQuestionProcessor]({%slug radpdfprocessing-features-gen-ai-powered-document-insights-complete-context-question-processor%})

0 commit comments

Comments
 (0)