Skip to content

Commit b710f92

Browse files
Aspose.Slides for .NET 25.6 API Reference
1 parent aa729cf commit b710f92

File tree

1,199 files changed

+1855
-1241
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,199 files changed

+1855
-1241
lines changed

content/net/english/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ is_root: true
1313
| Namespace | Description |
1414
| --- | --- |
1515
| [Aspose.Slides](./aspose.slides) | Contains classes for work with Microsoft PowerPoint presentations without utilizing Microsoft PowerPoint. |
16+
| [Aspose.Slides.AI](./aspose.slides.ai) | |
1617
| [Aspose.Slides.Animation](./aspose.slides.animation) | Contains classes for work with animation in Microsoft PowerPoint presentations. |
1718
| [Aspose.Slides.Charts](./aspose.slides.charts) | Contains classes for work with charts in Microsoft PowerPoint presentations. |
1819
| [Aspose.Slides.DOM.Ole](./aspose.slides.dom.ole) | Contains classes for work with OLE objects in Microsoft PowerPoint presentations. |
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Aspose.Slides.AI
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description:
5+
type: docs
6+
weight: 20
7+
url: /aspose.slides.ai/
8+
---
9+
10+
11+
12+
## Classes
13+
14+
| Class | Description |
15+
| --- | --- |
16+
| [OpenAIWebClient](./openaiwebclient) | Build-in lightweight OpenAI web client |
17+
| [SlidesAIAgent](./slidesaiagent) | Provides AI-powered features for processing presentations. |
18+
| [SlidesAIAgentException](./slidesaiagentexception) | Represents Slides AI Agent related exceptions. |
19+
## Interfaces
20+
21+
| Interface | Description |
22+
| --- | --- |
23+
| [IAIWebClient](./iaiwebclient) | AI Web client interface. This interface enables to substitute different AI language models. Classes that implement this interface are supposed to be used along with !:SlidesAIAgent |
24+
25+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: IAIWebClient
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: AI Web client interface. This interface enables to substitute different AI language models. Classes that implement this interface are supposed to be used along with SlidesAIAgent
5+
type: docs
6+
weight: 10
7+
url: /aspose.slides.ai/iaiwebclient/
8+
---
9+
10+
## IAIWebClient interface
11+
12+
AI Web client interface. This interface enables to substitute different AI language models. Classes that implement this interface are supposed to be used along with !:SlidesAIAgent
13+
14+
```csharp
15+
public interface IAIWebClient
16+
```
17+
18+
## Methods
19+
20+
| Name | Description |
21+
| --- | --- |
22+
| [CallChatAsync](../../aspose.slides.ai/iaiwebclient/callchatasync)(string) | Sends a chat instruction to the AI model using a provided HttpClient instance and return response message to the given instruction. |
23+
24+
### See Also
25+
26+
* namespace [Aspose.Slides.AI](../../aspose.slides.ai)
27+
* assembly [Aspose.Slides](../../)
28+
29+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: CallChatAsync
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Sends a chat instruction to the AI model using a provided HttpClient instance and return response message to the given instruction.
5+
type: docs
6+
weight: 10
7+
url: /aspose.slides.ai/iaiwebclient/callchatasync/
8+
---
9+
10+
## IAIWebClient.CallChatAsync method
11+
12+
Sends a chat instruction to the AI model using a provided HttpClient instance and return response message to the given instruction.
13+
14+
```csharp
15+
public Task<string> CallChatAsync(string instruction)
16+
```
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| instruction | String | The instruction or message to be processed by the AI model. |
21+
22+
### Return Value
23+
24+
The message generated by the AI model in response to the given instruction.
25+
26+
### See Also
27+
28+
* interface [IAIWebClient](../../iaiwebclient)
29+
* namespace [Aspose.Slides.AI](../../iaiwebclient)
30+
* assembly [Aspose.Slides](../../../)
31+
32+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: OpenAIWebClient
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Build-in lightweight OpenAI web client
5+
type: docs
6+
weight: 20
7+
url: /aspose.slides.ai/openaiwebclient/
8+
---
9+
10+
## OpenAIWebClient class
11+
12+
Build-in lightweight OpenAI web client
13+
14+
```csharp
15+
public class OpenAIWebClient : IAIWebClient, IDisposable
16+
```
17+
18+
## Constructors
19+
20+
| Name | Description |
21+
| --- | --- |
22+
| [OpenAIWebClient](openaiwebclient#constructor)(stringstringstring) | Creates instance of OpenAI Web client. |
23+
| [OpenAIWebClient](openaiwebclient#constructor_1)(stringstringstringHttpClient) | Creates instance of OpenAI Web client. |
24+
25+
## Methods
26+
27+
| Name | Description |
28+
| --- | --- |
29+
| [CallChatAsync](../../aspose.slides.ai/openaiwebclient/callchatasync)(string) | Sends a chat instruction to the AI model using an externally managed HttpClient instance and returns response message to the given instruction. |
30+
| [Dispose](../../aspose.slides.ai/openaiwebclient/dispose)() | Releases resources used by this instance. |
31+
32+
### See Also
33+
34+
* interface [IAIWebClient](../iaiwebclient)
35+
* namespace [Aspose.Slides.AI](../../aspose.slides.ai)
36+
* assembly [Aspose.Slides](../../)
37+
38+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: CallChatAsync
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Sends a chat instruction to the AI model using an externally managed HttpClient instance and returns response message to the given instruction.
5+
type: docs
6+
weight: 20
7+
url: /aspose.slides.ai/openaiwebclient/callchatasync/
8+
---
9+
10+
## OpenAIWebClient.CallChatAsync method
11+
12+
Sends a chat instruction to the AI model using an externally managed HttpClient instance and returns response message to the given instruction.
13+
14+
```csharp
15+
public Task<string> CallChatAsync(string instruction)
16+
```
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| instruction | String | The instruction or message to be processed by the AI model. |
21+
22+
### Return Value
23+
24+
The message generated by the AI model in response to the given instruction.
25+
26+
### Exceptions
27+
28+
| exception | condition |
29+
| --- | --- |
30+
| ArgumentException | Open AI chat instruction can't be null or empty |
31+
| ArgumentNullException | HttpClient instance is not provided |
32+
33+
### See Also
34+
35+
* class [OpenAIWebClient](../../openaiwebclient)
36+
* namespace [Aspose.Slides.AI](../../openaiwebclient)
37+
* assembly [Aspose.Slides](../../../)
38+
39+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Dispose
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Releases resources used by this instance.
5+
type: docs
6+
weight: 30
7+
url: /aspose.slides.ai/openaiwebclient/dispose/
8+
---
9+
10+
## OpenAIWebClient.Dispose method
11+
12+
Releases resources used by this instance.
13+
14+
```csharp
15+
public void Dispose()
16+
```
17+
18+
### See Also
19+
20+
* class [OpenAIWebClient](../../openaiwebclient)
21+
* namespace [Aspose.Slides.AI](../../openaiwebclient)
22+
* assembly [Aspose.Slides](../../../)
23+
24+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: OpenAIWebClient
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Creates instance of OpenAI Web client.
5+
type: docs
6+
weight: 10
7+
url: /aspose.slides.ai/openaiwebclient/openaiwebclient/
8+
---
9+
10+
## OpenAIWebClient(string, string, string) {#constructor}
11+
12+
Creates instance of OpenAI Web client.
13+
14+
```csharp
15+
public OpenAIWebClient(string model, string apiKey, string organizationId)
16+
```
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| model | String | OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini |
21+
| apiKey | String | OpenAI API key |
22+
| organizationId | String | Organization ID (optional) |
23+
24+
### Exceptions
25+
26+
| exception | condition |
27+
| --- | --- |
28+
| ArgumentException | API key value can't be null or empty |
29+
| ArgumentException | Text model value can't be null or empty |
30+
31+
### See Also
32+
33+
* class [OpenAIWebClient](../../openaiwebclient)
34+
* namespace [Aspose.Slides.AI](../../openaiwebclient)
35+
* assembly [Aspose.Slides](../../../)
36+
37+
---
38+
39+
## OpenAIWebClient(string, string, string, HttpClient) {#constructor_1}
40+
41+
Creates instance of OpenAI Web client.
42+
43+
```csharp
44+
public OpenAIWebClient(string model, string apiKey, string organizationId, HttpClient httpClient)
45+
```
46+
47+
| Parameter | Type | Description |
48+
| --- | --- | --- |
49+
| model | String | OpenAI language model. Possible values: - gpt-4o - gpt-4o-mini - o1 - o1-mini - o3 - o3-mini |
50+
| apiKey | String | OpenAI API key |
51+
| organizationId | String | Organization ID (optional) |
52+
| httpClient | HttpClient | An externally managed HttpClient instance. |
53+
54+
### Exceptions
55+
56+
| exception | condition |
57+
| --- | --- |
58+
| ArgumentException | API key value can't be null or empty |
59+
| ArgumentException | Text model value can't be null or empty |
60+
61+
### See Also
62+
63+
* class [OpenAIWebClient](../../openaiwebclient)
64+
* namespace [Aspose.Slides.AI](../../openaiwebclient)
65+
* assembly [Aspose.Slides](../../../)
66+
67+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: SlidesAIAgent
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: Provides AI-powered features for processing presentations.
5+
type: docs
6+
weight: 30
7+
url: /aspose.slides.ai/slidesaiagent/
8+
---
9+
10+
## SlidesAIAgent class
11+
12+
Provides AI-powered features for processing presentations.
13+
14+
```csharp
15+
public class SlidesAIAgent
16+
```
17+
18+
## Constructors
19+
20+
| Name | Description |
21+
| --- | --- |
22+
| [SlidesAIAgent](slidesaiagent)(IAIWebClient) | SlidesAIAgent constructor |
23+
24+
## Methods
25+
26+
| Name | Description |
27+
| --- | --- |
28+
| [Translate](../../aspose.slides.ai/slidesaiagent/translate)(IPresentation, string) | Translates a presentation to the specified language using AI (synchronous version). |
29+
| [TranslateAsync](../../aspose.slides.ai/slidesaiagent/translateasync)(IPresentation, string) | Translates a presentation to the specified language using AI. |
30+
31+
### See Also
32+
33+
* namespace [Aspose.Slides.AI](../../aspose.slides.ai)
34+
* assembly [Aspose.Slides](../../)
35+
36+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: SlidesAIAgent
3+
second_title: Aspose.Sildes for .NET API Reference
4+
description: SlidesAIAgent constructor
5+
type: docs
6+
weight: 10
7+
url: /aspose.slides.ai/slidesaiagent/slidesaiagent/
8+
---
9+
10+
## SlidesAIAgent constructor
11+
12+
SlidesAIAgent constructor
13+
14+
```csharp
15+
public SlidesAIAgent(IAIWebClient aiClient)
16+
```
17+
18+
| Parameter | Type | Description |
19+
| --- | --- | --- |
20+
| aiClient | IAIWebClient | |
21+
22+
### Exceptions
23+
24+
| exception | condition |
25+
| --- | --- |
26+
| ArgumentNullException | AI client instance is not provided |
27+
28+
### See Also
29+
30+
* interface [IAIWebClient](../../iaiwebclient)
31+
* class [SlidesAIAgent](../../slidesaiagent)
32+
* namespace [Aspose.Slides.AI](../../slidesaiagent)
33+
* assembly [Aspose.Slides](../../../)
34+
35+
<!-- DO NOT EDIT: generated by xmldocmd for Aspose.Slides.dll -->

0 commit comments

Comments
 (0)