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

llama_cloud/types/pipeline_update_params.py

@@ -0,0 +1,90 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import TypeAlias, TypedDict
+
+from .data_sink_create_param import DataSinkCreateParam
+from .sparse_model_config_param import SparseModelConfigParam
+from .auto_transform_config_param import AutoTransformConfigParam
+from .llama_parse_parameters_param import LlamaParseParametersParam
+from .cohere_embedding_config_param import CohereEmbeddingConfigParam
+from .gemini_embedding_config_param import GeminiEmbeddingConfigParam
+from .openai_embedding_config_param import OpenAIEmbeddingConfigParam
+from .bedrock_embedding_config_param import BedrockEmbeddingConfigParam
+from .pipeline_metadata_config_param import PipelineMetadataConfigParam
+from .vertex_ai_embedding_config_param import VertexAIEmbeddingConfigParam
+from .azure_openai_embedding_config_param import AzureOpenAIEmbeddingConfigParam
+from .advanced_mode_transform_config_param import AdvancedModeTransformConfigParam
+from .hugging_face_inference_api_embedding_config_param import HuggingFaceInferenceAPIEmbeddingConfigParam
+
+__all__ = ["PipelineUpdateParams", "EmbeddingConfig", "TransformConfig"]
+
+
+class PipelineUpdateParams(TypedDict, total=False):
+    data_sink: Optional[DataSinkCreateParam]
+    """Schema for creating a data sink."""
+
+    data_sink_id: Optional[str]
+    """Data sink ID.
+
+    When provided instead of data_sink, the data sink will be looked up by ID.
+    """
+
+    embedding_config: Optional[EmbeddingConfig]
+
+    embedding_model_config_id: Optional[str]
+    """Embedding model config ID.
+
+    When provided instead of embedding_config, the embedding model config will be
+    looked up by ID.
+    """
+
+    llama_parse_parameters: Optional[LlamaParseParametersParam]
+    """
+    Settings that can be configured for how to use LlamaParse to parse files within
+    a LlamaCloud pipeline.
+    """
+
+    managed_pipeline_id: Optional[str]
+    """The ID of the ManagedPipeline this playground pipeline is linked to."""
+
+    metadata_config: Optional[PipelineMetadataConfigParam]
+    """Metadata configuration for the pipeline."""
+
+    name: Optional[str]
+
+    preset_retrieval_parameters: Optional["PresetRetrievalParamsParam"]
+    """
+    Schema for the search params for an retrieval execution that can be preset for a
+    pipeline.
+    """
+
+    sparse_model_config: Optional[SparseModelConfigParam]
+    """Configuration for sparse embedding models used in hybrid search.
+
+    This allows users to choose between Splade and BM25 models for sparse retrieval
+    in managed data sinks.
+    """
+
+    status: Optional[str]
+    """Status of the pipeline deployment."""
+
+    transform_config: Optional[TransformConfig]
+    """Configuration for the transformation."""
+
+
+EmbeddingConfig: TypeAlias = Union[
+    AzureOpenAIEmbeddingConfigParam,
+    CohereEmbeddingConfigParam,
+    GeminiEmbeddingConfigParam,
+    HuggingFaceInferenceAPIEmbeddingConfigParam,
+    OpenAIEmbeddingConfigParam,
+    VertexAIEmbeddingConfigParam,
+    BedrockEmbeddingConfigParam,
+]
+
+TransformConfig: TypeAlias = Union[AutoTransformConfigParam, AdvancedModeTransformConfigParam]
+
+from .preset_retrieval_params_param import PresetRetrievalParamsParam

llama_cloud/types/pipeline_upsert_params.py

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .pipeline_type import PipelineType
+from .data_sink_create_param import DataSinkCreateParam
+from .sparse_model_config_param import SparseModelConfigParam
+from .auto_transform_config_param import AutoTransformConfigParam
+from .llama_parse_parameters_param import LlamaParseParametersParam
+from .cohere_embedding_config_param import CohereEmbeddingConfigParam
+from .gemini_embedding_config_param import GeminiEmbeddingConfigParam
+from .openai_embedding_config_param import OpenAIEmbeddingConfigParam
+from .bedrock_embedding_config_param import BedrockEmbeddingConfigParam
+from .pipeline_metadata_config_param import PipelineMetadataConfigParam
+from .vertex_ai_embedding_config_param import VertexAIEmbeddingConfigParam
+from .azure_openai_embedding_config_param import AzureOpenAIEmbeddingConfigParam
+from .advanced_mode_transform_config_param import AdvancedModeTransformConfigParam
+from .hugging_face_inference_api_embedding_config_param import HuggingFaceInferenceAPIEmbeddingConfigParam
+
+__all__ = ["PipelineUpsertParams", "EmbeddingConfig", "TransformConfig"]
+
+
+class PipelineUpsertParams(TypedDict, total=False):
+    name: Required[str]
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    data_sink: Optional[DataSinkCreateParam]
+    """Schema for creating a data sink."""
+
+    data_sink_id: Optional[str]
+    """Data sink ID.
+
+    When provided instead of data_sink, the data sink will be looked up by ID.
+    """
+
+    embedding_config: Optional[EmbeddingConfig]
+
+    embedding_model_config_id: Optional[str]
+    """Embedding model config ID.
+
+    When provided instead of embedding_config, the embedding model config will be
+    looked up by ID.
+    """
+
+    llama_parse_parameters: LlamaParseParametersParam
+    """
+    Settings that can be configured for how to use LlamaParse to parse files within
+    a LlamaCloud pipeline.
+    """
+
+    managed_pipeline_id: Optional[str]
+    """The ID of the ManagedPipeline this playground pipeline is linked to."""
+
+    metadata_config: Optional[PipelineMetadataConfigParam]
+    """Metadata configuration for the pipeline."""
+
+    pipeline_type: PipelineType
+    """Type of pipeline. Either PLAYGROUND or MANAGED."""
+
+    preset_retrieval_parameters: "PresetRetrievalParamsParam"
+    """Preset retrieval parameters for the pipeline."""
+
+    sparse_model_config: Optional[SparseModelConfigParam]
+    """Configuration for sparse embedding models used in hybrid search.
+
+    This allows users to choose between Splade and BM25 models for sparse retrieval
+    in managed data sinks.
+    """
+
+    status: Optional[str]
+    """Status of the pipeline deployment."""
+
+    transform_config: Optional[TransformConfig]
+    """Configuration for the transformation."""
+
+
+EmbeddingConfig: TypeAlias = Union[
+    AzureOpenAIEmbeddingConfigParam,
+    CohereEmbeddingConfigParam,
+    GeminiEmbeddingConfigParam,
+    HuggingFaceInferenceAPIEmbeddingConfigParam,
+    OpenAIEmbeddingConfigParam,
+    VertexAIEmbeddingConfigParam,
+    BedrockEmbeddingConfigParam,
+]
+
+TransformConfig: TypeAlias = Union[AutoTransformConfigParam, AdvancedModeTransformConfigParam]
+
+from .preset_retrieval_params_param import PresetRetrievalParamsParam

llama_cloud/types/pipelines/__init__.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .text_node import TextNode as TextNode
+from .pipeline_file import PipelineFile as PipelineFile
+from .cloud_document import CloudDocument as CloudDocument
+from .file_list_params import FileListParams as FileListParams
+from .file_create_params import FileCreateParams as FileCreateParams
+from .file_update_params import FileUpdateParams as FileUpdateParams
+from .document_list_params import DocumentListParams as DocumentListParams
+from .file_create_response import FileCreateResponse as FileCreateResponse
+from .pipeline_data_source import PipelineDataSource as PipelineDataSource
+from .document_create_params import DocumentCreateParams as DocumentCreateParams
+from .document_upsert_params import DocumentUpsertParams as DocumentUpsertParams
+from .metadata_create_params import MetadataCreateParams as MetadataCreateParams
+from .data_source_sync_params import DataSourceSyncParams as DataSourceSyncParams
+from .document_create_response import DocumentCreateResponse as DocumentCreateResponse
+from .document_upsert_response import DocumentUpsertResponse as DocumentUpsertResponse
+from .metadata_create_response import MetadataCreateResponse as MetadataCreateResponse
+from .data_source_update_params import DataSourceUpdateParams as DataSourceUpdateParams
+from .cloud_document_create_param import CloudDocumentCreateParam as CloudDocumentCreateParam
+from .document_get_chunks_response import DocumentGetChunksResponse as DocumentGetChunksResponse
+from .image_get_page_figure_params import ImageGetPageFigureParams as ImageGetPageFigureParams
+from .file_get_status_counts_params import FileGetStatusCountsParams as FileGetStatusCountsParams
+from .image_list_page_figures_params import ImageListPageFiguresParams as ImageListPageFiguresParams
+from .file_get_status_counts_response import FileGetStatusCountsResponse as FileGetStatusCountsResponse
+from .image_get_page_screenshot_params import ImageGetPageScreenshotParams as ImageGetPageScreenshotParams
+from .image_list_page_figures_response import ImageListPageFiguresResponse as ImageListPageFiguresResponse
+from .image_list_page_screenshots_params import ImageListPageScreenshotsParams as ImageListPageScreenshotsParams
+from .image_list_page_screenshots_response import ImageListPageScreenshotsResponse as ImageListPageScreenshotsResponse
+from .data_source_get_data_sources_response import DataSourceGetDataSourcesResponse as DataSourceGetDataSourcesResponse
+from .data_source_update_data_sources_params import (
+    DataSourceUpdateDataSourcesParams as DataSourceUpdateDataSourcesParams,
+)
+from .data_source_update_data_sources_response import (
+    DataSourceUpdateDataSourcesResponse as DataSourceUpdateDataSourcesResponse,
+)

llama_cloud/types/pipelines/cloud_document.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["CloudDocument"]
+
+
+class CloudDocument(BaseModel):
+    """Cloud document stored in S3."""
+
+    id: str
+
+    metadata: Dict[str, object]
+
+    text: str
+
+    excluded_embed_metadata_keys: Optional[List[str]] = None
+
+    excluded_llm_metadata_keys: Optional[List[str]] = None
+
+    page_positions: Optional[List[int]] = None
+    """indices in the CloudDocument.text where a new page begins.
+
+    e.g. Second page starts at index specified by page_positions[1].
+    """
+
+    status_metadata: Optional[Dict[str, object]] = None

llama_cloud/types/pipelines/cloud_document_create_param.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["CloudDocumentCreateParam"]
+
+
+class CloudDocumentCreateParam(TypedDict, total=False):
+    """Create a new cloud document."""
+
+    metadata: Required[Dict[str, object]]
+
+    text: Required[str]
+
+    id: Optional[str]
+
+    excluded_embed_metadata_keys: SequenceNotStr[str]
+
+    excluded_llm_metadata_keys: SequenceNotStr[str]
+
+    page_positions: Optional[Iterable[int]]
+    """indices in the CloudDocument.text where a new page begins.
+
+    e.g. Second page starts at index specified by page_positions[1].
+    """

llama_cloud/types/pipelines/data_source_get_data_sources_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .pipeline_data_source import PipelineDataSource
+
+__all__ = ["DataSourceGetDataSourcesResponse"]
+
+DataSourceGetDataSourcesResponse: TypeAlias = List[PipelineDataSource]

llama_cloud/types/pipelines/data_source_sync_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 Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["DataSourceSyncParams"]
+
+
+class DataSourceSyncParams(TypedDict, total=False):
+    pipeline_id: Required[str]
+
+    pipeline_file_ids: Optional[SequenceNotStr[str]]

llama_cloud/types/pipelines/data_source_update_data_sources_params.py

@@ -0,0 +1,25 @@
+# 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
+
+__all__ = ["DataSourceUpdateDataSourcesParams", "Body"]
+
+
+class DataSourceUpdateDataSourcesParams(TypedDict, total=False):
+    body: Required[Iterable[Body]]
+
+
+class Body(TypedDict, total=False):
+    """Schema for creating an association between a data source and a pipeline."""
+
+    data_source_id: Required[str]
+    """The ID of the data source."""
+
+    sync_interval: Optional[float]
+    """The interval at which the data source should be synced.
+
+    Valid values are: 21600, 43200, 86400
+    """

llama_cloud/types/pipelines/data_source_update_data_sources_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .pipeline_data_source import PipelineDataSource
+
+__all__ = ["DataSourceUpdateDataSourcesResponse"]
+
+DataSourceUpdateDataSourcesResponse: TypeAlias = List[PipelineDataSource]

llama_cloud/types/pipelines/data_source_update_params.py

@@ -0,0 +1,15 @@
+# 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__ = ["DataSourceUpdateParams"]
+
+
+class DataSourceUpdateParams(TypedDict, total=False):
+    pipeline_id: Required[str]
+
+    sync_interval: Optional[float]
+    """The interval at which the data source should be synced."""

llama_cloud/types/pipelines/document_create_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 Iterable
+from typing_extensions import Required, TypedDict
+
+from .cloud_document_create_param import CloudDocumentCreateParam
+
+__all__ = ["DocumentCreateParams"]
+
+
+class DocumentCreateParams(TypedDict, total=False):
+    body: Required[Iterable[CloudDocumentCreateParam]]

llama_cloud/types/pipelines/document_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .cloud_document import CloudDocument
+
+__all__ = ["DocumentCreateResponse"]
+
+DocumentCreateResponse: TypeAlias = List[CloudDocument]

llama_cloud/types/pipelines/document_get_chunks_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .text_node import TextNode
+
+__all__ = ["DocumentGetChunksResponse"]
+
+DocumentGetChunksResponse: TypeAlias = List[TextNode]

llama_cloud/types/pipelines/document_list_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 Literal, TypedDict
+
+__all__ = ["DocumentListParams"]
+
+
+class DocumentListParams(TypedDict, total=False):
+    file_id: Optional[str]
+
+    limit: int
+
+    only_api_data_source_documents: Optional[bool]
+
+    only_direct_upload: Optional[bool]
+
+    skip: int
+
+    status_refresh_policy: Literal["cached", "ttl"]

llama_cloud/types/pipelines/document_upsert_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 Iterable
+from typing_extensions import Required, TypedDict
+
+from .cloud_document_create_param import CloudDocumentCreateParam
+
+__all__ = ["DocumentUpsertParams"]
+
+
+class DocumentUpsertParams(TypedDict, total=False):
+    body: Required[Iterable[CloudDocumentCreateParam]]

llama_cloud/types/pipelines/document_upsert_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .cloud_document import CloudDocument
+
+__all__ = ["DocumentUpsertResponse"]
+
+DocumentUpsertResponse: TypeAlias = List[CloudDocument]

llama_cloud/types/pipelines/file_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 Dict, Union, Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["FileCreateParams", "Body"]
+
+
+class FileCreateParams(TypedDict, total=False):
+    body: Required[Iterable[Body]]
+
+
+class Body(TypedDict, total=False):
+    """Schema for creating a file that is associated with a pipeline."""
+
+    file_id: Required[str]
+    """The ID of the file"""
+
+    custom_metadata: Optional[Dict[str, Union[Dict[str, object], Iterable[object], str, float, bool, None]]]
+    """Custom metadata for the file"""

llama_cloud/types/pipelines/file_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .pipeline_file import PipelineFile
+
+__all__ = ["FileCreateResponse"]
+
+FileCreateResponse: TypeAlias = List[PipelineFile]

llama_cloud/types/pipelines/file_get_status_counts_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__ = ["FileGetStatusCountsParams"]
+
+
+class FileGetStatusCountsParams(TypedDict, total=False):
+    data_source_id: Optional[str]
+
+    only_manually_uploaded: bool

llama_cloud/types/pipelines/file_get_status_counts_response.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["FileGetStatusCountsResponse"]
+
+
+class FileGetStatusCountsResponse(BaseModel):
+    counts: Dict[str, int]
+    """The counts of files by status"""
+
+    total_count: int
+    """The total number of files"""
+
+    data_source_id: Optional[str] = None
+    """The ID of the data source that the files belong to"""
+
+    only_manually_uploaded: Optional[bool] = None
+    """Whether to only count manually uploaded files"""
+
+    pipeline_id: Optional[str] = None
+    """The ID of the pipeline that the files belong to"""

llama_cloud/types/pipelines/file_list_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
+
+__all__ = ["FileListParams"]
+
+
+class FileListParams(TypedDict, total=False):
+    data_source_id: Optional[str]
+
+    file_name_contains: Optional[str]
+
+    limit: Optional[int]
+
+    offset: Optional[int]
+
+    only_manually_uploaded: bool
+
+    order_by: Optional[str]

llama_cloud/types/pipelines/file_update_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["FileUpdateParams"]
+
+
+class FileUpdateParams(TypedDict, total=False):
+    pipeline_id: Required[str]
+
+    custom_metadata: Optional[Dict[str, Union[Dict[str, object], Iterable[object], str, float, bool, None]]]
+    """Custom metadata for the file"""

llama_cloud/types/pipelines/image_get_page_figure_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 Required, TypedDict
+
+__all__ = ["ImageGetPageFigureParams"]
+
+
+class ImageGetPageFigureParams(TypedDict, total=False):
+    id: Required[str]
+
+    page_index: Required[int]
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/pipelines/image_get_page_screenshot_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 Required, TypedDict
+
+__all__ = ["ImageGetPageScreenshotParams"]
+
+
+class ImageGetPageScreenshotParams(TypedDict, total=False):
+    id: Required[str]
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/pipelines/image_list_page_figures_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__ = ["ImageListPageFiguresParams"]
+
+
+class ImageListPageFiguresParams(TypedDict, total=False):
+    organization_id: Optional[str]
+
+    project_id: Optional[str]

llama_cloud/types/pipelines/image_list_page_figures_response.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["ImageListPageFiguresResponse", "ImageListPageFiguresResponseItem"]
+
+
+class ImageListPageFiguresResponseItem(BaseModel):
+    confidence: float
+    """The confidence of the figure"""
+
+    figure_name: str
+    """The name of the figure"""
+
+    figure_size: int
+    """The size of the figure in bytes"""
+
+    file_id: str
+    """The ID of the file that the figure was taken from"""
+
+    page_index: int
+    """The index of the page for which the figure is taken (0-indexed)"""
+
+    is_likely_noise: Optional[bool] = None
+    """Whether the figure is likely to be noise"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """Metadata for the figure"""
+
+
+ImageListPageFiguresResponse: TypeAlias = List[ImageListPageFiguresResponseItem]