Skip to content

Commit 3fa5970

Browse files
KotovDEKotovDE
authored
Merge pull request #174 from aspose-words/main
Added Api Refs for Aspose.Words for Python via .Net 25.11.0
2 parents 5294e8c + b5911a8 commit 3fa5970

File tree

412 files changed

+1647
-1016
lines changed

Some content is hidden

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

412 files changed

+1647
-1016
lines changed

‎english/python-net/aspose.words.ai/aimodel/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ url: /python-net/aspose.words.ai/aimodel/
1414
An abstract class representing the integration with various AI models within the Aspose.Words.
1515

1616

17+
### Properties
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [timeout](./timeout/) | Gets or sets the number of milliseconds to wait before the request to AI model times out. The default value is 100,000 milliseconds (100 seconds). |
22+
| [url](./url/) | Gets or sets a URL of the model. The default value is specific for the model. |
23+
1724
### Methods
1825

1926
| Name | Description |

‎english/python-net/aspose.words.ai/aimodel/as_anthropic_ai_model/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: as_anthropic_ai_model method
55
second_title: Aspose.Words for Python
66
description: "AiModel.as_anthropic_ai_model method. Cast AiModel to [AnthropicAiModel](../../anthropicaimodel/)."
77
type: docs
8-
weight: 10
8+
weight: 30
99
url: /python-net/aspose.words.ai/aimodel/as_anthropic_ai_model/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/as_google_ai_model/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: as_google_ai_model method
55
second_title: Aspose.Words for Python
66
description: "AiModel.as_google_ai_model method. Cast AiModel to [GoogleAiModel](../../googleaimodel/)."
77
type: docs
8-
weight: 20
8+
weight: 40
99
url: /python-net/aspose.words.ai/aimodel/as_google_ai_model/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/as_open_ai_model/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: as_open_ai_model method
55
second_title: Aspose.Words for Python
66
description: "AiModel.as_open_ai_model method. Cast AiModel to [OpenAiModel](../../openaimodel/)."
77
type: docs
8-
weight: 30
8+
weight: 50
99
url: /python-net/aspose.words.ai/aimodel/as_open_ai_model/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/check_grammar/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: check_grammar method
55
second_title: Aspose.Words for Python
66
description: "AiModel.check_grammar method. Checks grammar of the provided document"
77
type: docs
8-
weight: 40
8+
weight: 60
99
url: /python-net/aspose.words.ai/aimodel/check_grammar/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/create/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: create method
55
second_title: Aspose.Words for Python
66
description: "AiModel.create method. Creates a new instance of [AiModel](../) class."
77
type: docs
8-
weight: 50
8+
weight: 70
99
url: /python-net/aspose.words.ai/aimodel/create/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/summarize/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: summarize method
55
second_title: Aspose.Words for Python
66
description: "aspose.words.ai.AiModel.summarize method"
77
type: docs
8-
weight: 60
8+
weight: 80
99
url: /python-net/aspose.words.ai/aimodel/summarize/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/timeout/_index.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: AiModel.timeout property
3+
linktitle: timeout property
4+
articleTitle: timeout property
5+
second_title: Aspose.Words for Python
6+
description: "AiModel.timeout property. Gets or sets the number of milliseconds to wait before the request to AI model times out"
7+
type: docs
8+
weight: 10
9+
url: /python-net/aspose.words.ai/aimodel/timeout/
10+
---
11+
12+
## AiModel.timeout property
13+
14+
Gets or sets the number of milliseconds to wait before the request to AI model times out.
15+
The default value is 100,000 milliseconds (100 seconds).
16+
17+
18+
```python
19+
@property
20+
def timeout(self) -> int:
21+
...
22+
23+
@timeout.setter
24+
def timeout(self, value: int):
25+
...
26+
27+
```
28+
29+
### Examples
30+
31+
Shows how to change model default timeout.
32+
33+
```python
34+
api_key = system_helper.environment.Environment.get_environment_variable('API_KEY')
35+
model = aw.ai.AiModel.create(aw.ai.AiModelType.GPT_4O_MINI).with_api_key(api_key)
36+
# Default value 100000ms.
37+
model.timeout = 250000
38+
```
39+
40+
### See Also
41+
42+
* module [aspose.words.ai](../../)
43+
* class [AiModel](../)
44+

‎english/python-net/aspose.words.ai/aimodel/translate/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ articleTitle: translate method
55
second_title: Aspose.Words for Python
66
description: "AiModel.translate method. Translates the provided document into the specified target language"
77
type: docs
8-
weight: 70
8+
weight: 90
99
url: /python-net/aspose.words.ai/aimodel/translate/
1010
---
1111

‎english/python-net/aspose.words.ai/aimodel/url/_index.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: AiModel.url property
3+
linktitle: url property
4+
articleTitle: url property
5+
second_title: Aspose.Words for Python
6+
description: "AiModel.url property. Gets or sets a URL of the model"
7+
type: docs
8+
weight: 20
9+
url: /python-net/aspose.words.ai/aimodel/url/
10+
---
11+
12+
## AiModel.url property
13+
14+
Gets or sets a URL of the model.
15+
The default value is specific for the model.
16+
17+
18+
```python
19+
@property
20+
def url(self) -> str:
21+
...
22+
23+
@url.setter
24+
def url(self, value: str):
25+
...
26+
27+
```
28+
29+
### Examples
30+
31+
Shows how to check the grammar of a document.
32+
33+
```python
34+
doc = aw.Document(file_name=MY_DIR + 'Big document.docx')
35+
api_key = system_helper.environment.Environment.get_environment_variable('API_KEY')
36+
# Use OpenAI generative language models.
37+
model = aw.ai.AiModel.create(aw.ai.AiModelType.GPT_4O_MINI).with_api_key(api_key)
38+
grammar_options = aw.ai.CheckGrammarOptions()
39+
grammar_options.improve_stylistics = True
40+
proofed_doc = model.check_grammar(doc, grammar_options)
41+
proofed_doc.save(file_name=ARTIFACTS_DIR + 'AI.AiGrammar.docx')
42+
```
43+
44+
Shows how to change model default url.
45+
46+
```python
47+
api_key = system_helper.environment.Environment.get_environment_variable('API_KEY')
48+
model = aw.ai.AiModel.create(aw.ai.AiModelType.GPT_4O_MINI).with_api_key(api_key)
49+
# Default value "https:#api.openai.com/".
50+
model.url = 'https://my.a.com/'
51+
```
52+
53+
### See Also
54+
55+
* module [aspose.words.ai](../../)
56+
* class [AiModel](../)
57+

0 commit comments

Comments
 (0)