Skip to content
Merged
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
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ repos:
types: [python, text]
files: ^(examples/|docs/src/|packages/notte-sdk/src/).*\.(py|mdx)$
pass_filenames: false
- id: docs-sdk-generate
name: Regenerate SDK reference docs
entry: bash -c "make docs-sdk"
language: system
files: ^(packages/notte-sdk/src/|docs/sphinx/conf\.py)
pass_filenames: false
Comment thread
giordano-lucas marked this conversation as resolved.
- id: no-loguru-logger-import
name: Check for loguru logger imports
entry: 'from loguru import logger'
Expand Down
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/manual/session.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You can use the default parameters to create your session, or customize them:
File Storage to attach to the session
</ParamField>

<ParamField path="perception_type" type="Literal[fast, deep]" default="fast">
<ParamField path="perception_type" type="Literal['fast', 'deep']" default="fast">
</ParamField>

<ParamField path="cookie_file" type="UnionType[str, Path, None]" default="None">
Expand Down
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/misc/captchasolveaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ session.execute(type="captcha_solve") # Auto-detect captcha type
<ParamField path="description" type="str" default="Solve a CAPTCHA challenge on the current page. CRITICAL: Use this action as soon as you notice a captcha">
</ParamField>

<ParamField path="captcha_type" type="Optional[Literal['recaptcha', 'hcaptcha', 'image', 'text', 'auth0', 'cloudflare', 'datadome', 'arkose labs', 'geetest', 'press&hold', 'unknown']]">
<ParamField path="captcha_type" type="Literal['recaptcha', 'hcaptcha', 'image', 'text', 'auth0', 'cloudflare', 'datadome', 'arkose labs', 'geetest', 'press&hold', 'unknown'] | None">
</ParamField>


Expand Down
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/misc/formfillaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ session.execute(type="form_fill", value={"email": "user@example.com", "first_nam
<ParamField path="description" type="str" default="Fill a form with multiple values. Important: If you detect a form requesting personal information, try to use this action at first, and otherwise use the regular fill action. CRITICAL: If this action fails once, use the regular form fill instead.">
</ParamField>

<ParamField path="value" type="Dict[Literal[title, first_name, middle_name, last_name, full_name, email, company, address1, address2, address3, city, state, postal_code, country, phone, cc_name, cc_number, cc_exp_month, cc_exp_year, cc_exp, cc_cvv, username, password, current_password, new_password, totp], UnionType[str, ValueWithPlaceholder]]" required>
<ParamField path="value" type="Dict[Literal['title', 'first_name', 'middle_name', 'last_name', 'full_name', 'email', 'company', 'address1', 'address2', 'address3', 'city', 'state', 'postal_code', 'country', 'phone', 'cc_name', 'cc_number', 'cc_exp_month', 'cc_exp_year', 'cc_exp', 'cc_cvv', 'username', 'password', 'current_password', 'new_password', 'totp'], UnionType[str, ValueWithPlaceholder]]" required>
</ParamField>


Expand Down
16 changes: 16 additions & 0 deletions docs/src/sdk-reference/misc/rootmodel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "RootModel"
description: ""
---



## Fields

<ParamField path="root" type="Dict[str, Any] | list[Dict[str, Any]]" required>
</ParamField>


## Module

`pydantic.root_model`
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/misc/structureddata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: ""
Error message if the data was not extracted successfully
</ParamField>

<ParamField path="data" type="Union[pydantic.main.BaseModel, pydantic.root_model.RootModel[Union[dict[str, Any], list[dict[str, Any]]]], NoneType]">
<ParamField path="data" type="BaseModel | RootModel[Union[dict[str, Any], list[dict[str, Any]]]] | None">
Structured data extracted from the page in JSON format
</ParamField>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/misc/websocketservice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: "WebSocket client for receiving session recording data in binary fo
<ParamField path="wss_url" type="str" required>
</ParamField>

<ParamField path="process" type="Callable" required>
<ParamField path="process" type="Callable[[bytes], Any]" required>
</ParamField>


Expand Down
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/nottefunction/run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ function.run(variable1="value1", variable2="value2")
<ParamField path="workflow_run_id" type="UnionType[str, None]" default="None">
</ParamField>

<ParamField path="log_callback" type="UnionType[Callable[[<class 'str'>], None], None]" default="None">
<ParamField path="log_callback" type="UnionType[Callable[[str], None], None]" default="None">
</ParamField>

<ParamField path="variables" type="Any" required>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ description: "No description available"
<ParamField path="arg_index" type="int" required>
</ParamField>

<ParamField path="replacement_map_fn" type="Callable[Ellipsis, Dict[str, str]]" required>
<ParamField path="replacement_map_fn" type="Callable[..., Dict[str, str]]" required>
</ParamField>
2 changes: 1 addition & 1 deletion docs/src/sdk-reference/remotesession/__init__.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ RemoteSession instance configured with the specified parameters.
File Storage to attach to the session
</ParamField>

<ParamField path="perception_type" type="Literal[fast, deep]" default="fast">
<ParamField path="perception_type" type="Literal['fast', 'deep']" default="fast">
</ParamField>

<ParamField path="cookie_file" type="UnionType[str, Path, None]" default="None">
Expand Down
1 change: 0 additions & 1 deletion makefile
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ profile-imports:

.PHONY: docs-sdk
docs-sdk:
@uv pip install -e ../sphinx_mintlify
cd docs && uv run sphinx-build -b mdx sphinx _build
rm -rf docs/src/sdk-reference/baseaction

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ dev = [
"pytest-timeout>=2.4.0",
"pytest-xdist[psutil]>=3.8.0",
"sphinx>=8.2.3",
"sphinx-mintlify>=0.1.0",
Comment thread
giordano-lucas marked this conversation as resolved.
"twine>=6.1.0",
]
lint = [
Expand Down
16 changes: 16 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading