llama-cloud 0.1.41__py3-none-any.whl → 1.0.0b4__py3-none-any.whl

llama_cloud/types/beta/parse_configuration_get_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["ParseConfigurationGetParams"]
+
+
+class ParseConfigurationGetParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/parse_configuration_list_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["ParseConfigurationListParams"]
+
+
+class ParseConfigurationListParams(TypedDict, total=False):
+    creator: Optional[str]
+
+    name: Optional[str]
+
+    organization_id: Optional[str]
+
+    page_size: Optional[int]
+
+    page_token: Optional[str]
+
+    project_id: Optional[str]
+
+    version: Optional[str]

llama_cloud/types/beta/parse_configuration_query_response.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .parse_configuration import ParseConfiguration
+
+__all__ = ["ParseConfigurationQueryResponse"]
+
+
+class ParseConfigurationQueryResponse(BaseModel):
+    """Response schema for paginated parse configuration queries."""
+
+    items: List[ParseConfiguration]
+    """The list of items."""
+
+    next_page_token: Optional[str] = None
+    """A token, which can be sent as page_token to retrieve the next page.
+
+    If this field is omitted, there are no subsequent pages.
+    """
+
+    total_size: Optional[int] = None
+    """The total number of items available.
+
+    This is only populated when specifically requested. The value may be an estimate
+    and can be used for display purposes only.
+    """

llama_cloud/types/beta/parse_configuration_update_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+from ..llama_parse_parameters_param import LlamaParseParametersParam
+
+__all__ = ["ParseConfigurationUpdateParams"]
+
+
+class ParseConfigurationUpdateParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    parameters: Optional[LlamaParseParametersParam]
+    """
+    Settings that can be configured for how to use LlamaParse to parse files within
+    a LlamaCloud pipeline.
+    """

llama_cloud/types/beta/sheet_create_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+from .sheets_parsing_config_param import SheetsParsingConfigParam
+
+__all__ = ["SheetCreateParams"]
+
+
+class SheetCreateParams(TypedDict, total=False):
+    file_id: Required[str]
+    """The ID of the file to parse"""
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    config: SheetsParsingConfigParam
+    """Configuration for the parsing job"""

llama_cloud/types/beta/sheet_delete_job_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SheetDeleteJobParams"]
+
+
+class SheetDeleteJobParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/sheet_get_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SheetGetParams"]
+
+
+class SheetGetParams(TypedDict, total=False):
+    include_results: bool
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/sheet_get_result_table_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SheetGetResultTableParams"]
+
+
+class SheetGetResultTableParams(TypedDict, total=False):
+    spreadsheet_job_id: Required[str]
+
+    region_id: Required[str]
+
+    expires_at_seconds: Optional[int]
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/sheet_list_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SheetListParams"]
+
+
+class SheetListParams(TypedDict, total=False):
+    include_results: bool
+
+    organization_id: Optional[str]
+
+    page_size: Optional[int]
+
+    page_token: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/sheets_job.py

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..file import File
+from ..._models import BaseModel
+from ..status_enum import StatusEnum
+from .sheets_parsing_config import SheetsParsingConfig
+
+__all__ = ["SheetsJob", "Region", "WorksheetMetadata"]
+
+
+class Region(BaseModel):
+    """A summary of a single extracted region from a spreadsheet"""
+
+    location: str
+    """Location of the region in the spreadsheet"""
+
+    region_type: str
+    """Type of the extracted region"""
+
+    sheet_name: str
+    """Worksheet name where region was found"""
+
+    description: Optional[str] = None
+    """Generated description for the region"""
+
+    region_id: Optional[str] = None
+    """Unique identifier for this region within the file"""
+
+    title: Optional[str] = None
+    """Generated title for the region"""
+
+
+class WorksheetMetadata(BaseModel):
+    """Metadata about a worksheet in a spreadsheet"""
+
+    sheet_name: str
+    """Name of the worksheet"""
+
+    description: Optional[str] = None
+    """Generated description of the worksheet"""
+
+    title: Optional[str] = None
+    """Generated title for the worksheet"""
+
+
+class SheetsJob(BaseModel):
+    """A spreadsheet parsing job"""
+
+    id: str
+    """The ID of the job"""
+
+    config: SheetsParsingConfig
+    """Configuration for the parsing job"""
+
+    created_at: str
+    """When the job was created"""
+
+    file_id: Optional[str] = None
+    """The ID of the input file"""
+
+    project_id: str
+    """The ID of the project"""
+
+    status: StatusEnum
+    """The status of the parsing job"""
+
+    updated_at: str
+    """When the job was last updated"""
+
+    user_id: str
+    """The ID of the user"""
+
+    errors: Optional[List[str]] = None
+    """Any errors encountered"""
+
+    file: Optional[File] = None
+    """Schema for a file."""
+
+    regions: Optional[List[Region]] = None
+    """All extracted regions (populated when job is complete)"""
+
+    success: Optional[bool] = None
+    """Whether the job completed successfully"""
+
+    worksheet_metadata: Optional[List[WorksheetMetadata]] = None
+    """Metadata for each processed worksheet (populated when job is complete)"""

llama_cloud/types/beta/sheets_parsing_config.py

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["SheetsParsingConfig"]
+
+
+class SheetsParsingConfig(BaseModel):
+    """Configuration for spreadsheet parsing and region extraction"""
+
+    extraction_range: Optional[str] = None
+    """A1 notation of the range to extract a single region from.
+
+    If None, the entire sheet is used.
+    """
+
+    flatten_hierarchical_tables: Optional[bool] = None
+    """
+    Return a flattened dataframe when a detected table is recognized as
+    hierarchical.
+    """
+
+    generate_additional_metadata: Optional[bool] = None
+    """
+    Whether to generate additional metadata (title, description) for each extracted
+    region.
+    """
+
+    include_hidden_cells: Optional[bool] = None
+    """Whether to include hidden cells when extracting regions from the spreadsheet."""
+
+    sheet_names: Optional[List[str]] = None
+    """The names of the sheets to extract regions from.
+
+    If empty, all sheets will be processed.
+    """
+
+    table_merge_sensitivity: Optional[Literal["strong", "weak"]] = None
+    """Influences how likely similar-looking regions are merged into a single table.
+
+    Useful for spreadsheets that either have sparse tables (strong merging) or many
+    distinct tables close together (weak merging).
+    """
+
+    use_experimental_processing: Optional[bool] = None
+    """Enables experimental processing. Accuracy may be impacted."""

llama_cloud/types/beta/sheets_parsing_config_param.py

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["SheetsParsingConfigParam"]
+
+
+class SheetsParsingConfigParam(TypedDict, total=False):
+    """Configuration for spreadsheet parsing and region extraction"""
+
+    extraction_range: Optional[str]
+    """A1 notation of the range to extract a single region from.
+
+    If None, the entire sheet is used.
+    """
+
+    flatten_hierarchical_tables: bool
+    """
+    Return a flattened dataframe when a detected table is recognized as
+    hierarchical.
+    """
+
+    generate_additional_metadata: bool
+    """
+    Whether to generate additional metadata (title, description) for each extracted
+    region.
+    """
+
+    include_hidden_cells: bool
+    """Whether to include hidden cells when extracting regions from the spreadsheet."""
+
+    sheet_names: Optional[SequenceNotStr[str]]
+    """The names of the sheets to extract regions from.
+
+    If empty, all sheets will be processed.
+    """
+
+    table_merge_sensitivity: Literal["strong", "weak"]
+    """Influences how likely similar-looking regions are merged into a single table.
+
+    Useful for spreadsheets that either have sparse tables (strong merging) or many
+    distinct tables close together (weak merging).
+    """
+
+    use_experimental_processing: bool
+    """Enables experimental processing. Accuracy may be impacted."""

llama_cloud/types/beta/split_category.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["SplitCategory"]
+
+
+class SplitCategory(BaseModel):
+    """Category definition for document splitting."""
+
+    name: str
+    """Name of the category."""
+
+    description: Optional[str] = None
+    """Optional description of what content belongs in this category."""

llama_cloud/types/beta/split_category_param.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SplitCategoryParam"]
+
+
+class SplitCategoryParam(TypedDict, total=False):
+    """Category definition for document splitting."""
+
+    name: Required[str]
+    """Name of the category."""
+
+    description: Optional[str]
+    """Optional description of what content belongs in this category."""

llama_cloud/types/beta/split_create_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+from .split_category_param import SplitCategoryParam
+from .split_document_input_param import SplitDocumentInputParam
+
+__all__ = ["SplitCreateParams", "SplittingStrategy"]
+
+
+class SplitCreateParams(TypedDict, total=False):
+    categories: Required[Iterable[SplitCategoryParam]]
+    """Categories to split the document into."""
+
+    document_input: Required[SplitDocumentInputParam]
+    """Document to be split."""
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    splitting_strategy: SplittingStrategy
+    """Strategy for splitting the document."""
+
+
+class SplittingStrategy(TypedDict, total=False):
+    """Strategy for splitting the document."""
+
+    allow_uncategorized: bool
+    """
+    Whether to allow pages that don't match any category to be grouped as
+    'uncategorized'. If False, all pages must be assigned to a defined category.
+    """

llama_cloud/types/beta/split_create_response.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+from .split_category import SplitCategory
+from .split_document_input import SplitDocumentInput
+from .split_result_response import SplitResultResponse
+
+__all__ = ["SplitCreateResponse"]
+
+
+class SplitCreateResponse(BaseModel):
+    """A document split job."""
+
+    id: str
+    """Unique identifier for the split job."""
+
+    categories: List[SplitCategory]
+    """Categories used for splitting."""
+
+    document_input: SplitDocumentInput
+    """Document that was split."""
+
+    project_id: str
+    """Project ID this job belongs to."""
+
+    status: str
+    """Current status of the job.
+
+    Valid values are: pending, processing, completed, failed.
+    """
+
+    user_id: str
+    """User ID who created this job."""
+
+    created_at: Optional[datetime] = None
+    """Creation datetime"""
+
+    error_message: Optional[str] = None
+    """Error message if the job failed."""
+
+    result: Optional[SplitResultResponse] = None
+    """Result of a completed split job."""
+
+    updated_at: Optional[datetime] = None
+    """Update datetime"""

llama_cloud/types/beta/split_document_input.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["SplitDocumentInput"]
+
+
+class SplitDocumentInput(BaseModel):
+    """Document input specification."""
+
+    type: str
+    """Type of document input. Valid values are: file_id"""
+
+    value: str
+    """Document identifier."""

llama_cloud/types/beta/split_document_input_param.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SplitDocumentInputParam"]
+
+
+class SplitDocumentInputParam(TypedDict, total=False):
+    """Document input specification."""
+
+    type: Required[str]
+    """Type of document input. Valid values are: file_id"""
+
+    value: Required[str]
+    """Document identifier."""

llama_cloud/types/beta/split_get_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SplitGetParams"]
+
+
+class SplitGetParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/split_get_response.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+from .split_category import SplitCategory
+from .split_document_input import SplitDocumentInput
+from .split_result_response import SplitResultResponse
+
+__all__ = ["SplitGetResponse"]
+
+
+class SplitGetResponse(BaseModel):
+    """A document split job."""
+
+    id: str
+    """Unique identifier for the split job."""
+
+    categories: List[SplitCategory]
+    """Categories used for splitting."""
+
+    document_input: SplitDocumentInput
+    """Document that was split."""
+
+    project_id: str
+    """Project ID this job belongs to."""
+
+    status: str
+    """Current status of the job.
+
+    Valid values are: pending, processing, completed, failed.
+    """
+
+    user_id: str
+    """User ID who created this job."""
+
+    created_at: Optional[datetime] = None
+    """Creation datetime"""
+
+    error_message: Optional[str] = None
+    """Error message if the job failed."""
+
+    result: Optional[SplitResultResponse] = None
+    """Result of a completed split job."""
+
+    updated_at: Optional[datetime] = None
+    """Update datetime"""

llama_cloud/types/beta/split_list_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["SplitListParams"]
+
+
+class SplitListParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    page_size: Optional[int]
+
+    page_token: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/beta/split_list_response.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ..._models import BaseModel
+from .split_category import SplitCategory
+from .split_document_input import SplitDocumentInput
+from .split_result_response import SplitResultResponse
+
+__all__ = ["SplitListResponse"]
+
+
+class SplitListResponse(BaseModel):
+    """A document split job."""
+
+    id: str
+    """Unique identifier for the split job."""
+
+    categories: List[SplitCategory]
+    """Categories used for splitting."""
+
+    document_input: SplitDocumentInput
+    """Document that was split."""
+
+    project_id: str
+    """Project ID this job belongs to."""
+
+    status: str
+    """Current status of the job.
+
+    Valid values are: pending, processing, completed, failed.
+    """
+
+    user_id: str
+    """User ID who created this job."""
+
+    created_at: Optional[datetime] = None
+    """Creation datetime"""
+
+    error_message: Optional[str] = None
+    """Error message if the job failed."""
+
+    result: Optional[SplitResultResponse] = None
+    """Result of a completed split job."""
+
+    updated_at: Optional[datetime] = None
+    """Update datetime"""