Extract
Extract
Returned by: JinkoClient.create_extract, JinkoClient.get_extract, JinkoClient.iter_extracts, JinkoClient.list_extracts, Reference.create_extract, Reference.create_extract_from_pdf_quote, Reference.iter_extracts, Reference.list_extracts
Also has every member of ProjectItem.
| Member | Kind | Description |
|---|---|---|
rename | method | |
set_description | method | |
move_to_folder | method | |
source | property | Return the reference this extract belongs to. |
formulation | property | Return the extract formulation text, if any. |
classification_type | property | Return the extract classification type, if any. |
classification_level | property | Return the extract classification level, if any. |
highlights | property | Return the highlights belonging to this extract. |
rename
rename(name: str, *, version: str | dict | None = None) -> Self
set_description
set_description(
description: str, *, version: str | dict | None = None
) -> Self
move_to_folder
move_to_folder(
folder: Any = None, *, version: str | dict | None = None
) -> Self
source
Type: Reference
Return the reference this extract belongs to.
formulation
Type: str | None
Return the extract formulation text, if any.
classification_type
Type: Literal['Statement', 'Hypothesis', 'Data'] | None
Return the extract classification type, if any.
classification_level
Type: Literal['Weak', 'Medium', 'Strong', 'Excellent'] | None
Return the extract classification level, if any.
highlights
Type: list[Highlight]
Return the highlights belonging to this extract.
Highlight
An API highlight belonging to an extract.
Highlight fields are intentionally exposed without schema validation so the SDK remains usable when the API adds fields or changes optional values.
Returned by: Extract.highlights
| Member | Kind | Description |
|---|---|---|
parent_extract | attribute | |
id | property | |
type | property | |
text | property | |
file | property | |
latex | property | |
data_table | property | |
anchors | property | |
color | property | |
created_at | property | |
updated_at | property | |
url | property |
parent_extract
id
Type: Any
type
Type: Any
text
Type: Any
file
Type: Any
latex
Type: Any
data_table
Type: Any
anchors
Type: Any
color
Type: Any
created_at
Type: Any
updated_at
Type: Any
url
Type: str