151 lines
3.8 KiB
Markdown
151 lines
3.8 KiB
Markdown
# Python API
|
|
|
|
## Operations
|
|
|
|
::: docetl.schemas.MapOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.ResolveOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.ReduceOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.ParallelMapOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.FilterOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.EquijoinOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.SplitOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.GatherOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.UnnestOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.SampleOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.ClusterOp
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
## Dataset and Pipeline
|
|
|
|
::: docetl.schemas.Dataset
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.ParsingTool
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
|
|
::: docetl.schemas.PipelineStep
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.schemas.PipelineOutput
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|
|
|
|
::: docetl.api.Pipeline
|
|
options:
|
|
show_root_heading: true
|
|
heading_level: 3
|
|
show_if_no_docstring: false
|
|
docstring_options:
|
|
ignore_init_summary: false
|
|
trim_doctest_flags: true
|