Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api-reference/python/aixplain/decorators/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: decorators
title: aixplain.decorators
---
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/python/aixplain/enums/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: enums
title: aixplain.enums
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: mixins
title: aixplain.factories.model_factory.mixins
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: designer
title: aixplain.modules.pipeline.designer
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: pipeline
title: aixplain.modules.pipeline
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: data_onboarding
title: aixplain.processes.data_onboarding
---
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/python/aixplain/processes/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ draft: true
draft: true
draft: true
draft: true
draft: true
sidebar_label: processes
title: aixplain.processes
---
Expand Down
20 changes: 10 additions & 10 deletions docs/api-reference/python/aixplain/v2/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ Handle bulk assignment to inputs.
def build_run_payload(**kwargs: Unpack[ModelRunParams]) -> dict
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L689)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L698)

Build the JSON payload for a model execution request.

Expand All @@ -457,7 +457,7 @@ never forwarded to the backend API.
def build_run_url(**kwargs: Unpack[ModelRunParams]) -> str
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L700)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L709)

Build the URL for running the model.

Expand All @@ -467,7 +467,7 @@ Build the URL for running the model.
def mark_as_deleted() -> None
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L705)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L714)

Mark the model as deleted by setting status to DELETED and calling parent method.

Expand All @@ -479,7 +479,7 @@ def get(cls: type["Model"], id: str,
**kwargs: Unpack[BaseGetParams]) -> "Model"
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L713)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L722)

Get a model by ID.

Expand All @@ -492,7 +492,7 @@ def search(cls: type["Model"],
**kwargs: Unpack[ModelSearchParams]) -> Page["Model"]
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L722)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L731)

Search with optional query and filtering.

Expand All @@ -512,7 +512,7 @@ Search with optional query and filtering.
def run(**kwargs: Unpack[ModelRunParams]) -> ModelResult
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L743)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L752)

Run the model with dynamic parameter validation and default handling.

Expand All @@ -526,7 +526,7 @@ This method routes the execution based on the model's connection type:
def run_async(**kwargs: Unpack[ModelRunParams]) -> ModelResult
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L793)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L802)

Run the model asynchronously.

Expand All @@ -545,7 +545,7 @@ This method routes the execution based on the model's connection type:
def run_stream(**kwargs: Unpack[ModelRunParams]) -> ModelResponseStreamer
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L889)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L898)

Run the model with streaming response.

Expand Down Expand Up @@ -588,7 +588,7 @@ or processing large responses incrementally.
def as_tool() -> ToolDict
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L1029)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L1038)

Serialize this model as a tool for agent creation.

Expand Down Expand Up @@ -621,7 +621,7 @@ expects for model tools.
def get_parameters() -> List[dict]
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L1087)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/model.py#L1096)

Get current parameter values for this model.

Expand Down
7 changes: 3 additions & 4 deletions docs/api-reference/python/aixplain/v2/utility.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,10 @@ Get a utility by ID.
#### run

```python
@classmethod
def run(cls: type["Utility"], **kwargs: Unpack[UtilityRunParams]) -> Result
def run(**kwargs: Unpack[UtilityRunParams]) -> Result
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/utility.py#L111)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/utility.py#L110)

Run the utility with provided parameters.

Expand All @@ -126,7 +125,7 @@ def search(cls: type["Utility"],
**kwargs: Unpack[UtilitySearchParams]) -> "Page[Utility]"
```

[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/utility.py#L123)
[[view_source]](https://github.com/aixplain/aiXplain/blob/main/aixplain/v2/utility.py#L122)

Search utilities with optional query and filtering.

Expand Down