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

llama_cloud/types/project_list_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 .project import Project
+
+__all__ = ["ProjectListResponse"]
+
+ProjectListResponse: TypeAlias = List[Project]

llama_cloud/types/re_rank_config_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_extensions import Literal, TypedDict
+
+__all__ = ["ReRankConfigParam"]
+
+
+class ReRankConfigParam(TypedDict, total=False):
+    top_n: int
+    """
+    The number of nodes to retrieve after reranking over retrieved nodes from all
+    retrieval tools.
+    """
+
+    type: Literal["system_default", "llm", "cohere", "bedrock", "score", "disabled"]
+    """The type of reranker to use."""

llama_cloud/types/retrieval_mode.py

@@ -1,29 +1,7 @@
-# This file was auto-generated by Fern from our API Definition.
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import enum
-import typing
+from typing_extensions import Literal, TypeAlias
 
-T_Result = typing.TypeVar("T_Result")
+__all__ = ["RetrievalMode"]
 
-
-class RetrievalMode(str, enum.Enum):
-    CHUNKS = "chunks"
-    FILES_VIA_METADATA = "files_via_metadata"
-    FILES_VIA_CONTENT = "files_via_content"
-    AUTO_ROUTED = "auto_routed"
-
-    def visit(
-        self,
-        chunks: typing.Callable[[], T_Result],
-        files_via_metadata: typing.Callable[[], T_Result],
-        files_via_content: typing.Callable[[], T_Result],
-        auto_routed: typing.Callable[[], T_Result],
-    ) -> T_Result:
-        if self is RetrievalMode.CHUNKS:
-            return chunks()
-        if self is RetrievalMode.FILES_VIA_METADATA:
-            return files_via_metadata()
-        if self is RetrievalMode.FILES_VIA_CONTENT:
-            return files_via_content()
-        if self is RetrievalMode.AUTO_ROUTED:
-            return auto_routed()
+RetrievalMode: TypeAlias = Literal["chunks", "files_via_metadata", "files_via_content", "auto_routed"]

llama_cloud/types/retriever.py

@@ -1,45 +1,38 @@
-# This file was auto-generated by Fern from our API Definition.
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import datetime as dt
-import typing
+from __future__ import annotations
 
-from ..core.datetime_utils import serialize_datetime
-from .retriever_pipeline import RetrieverPipeline
+from typing import List, Optional
+from datetime import datetime
 
-try:
-    import pydantic
-    if pydantic.__version__.startswith("1."):
-        raise ImportError
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
+from .._models import BaseModel
 
+__all__ = ["Retriever"]
 
-class Retriever(pydantic.BaseModel):
-    """
-    An entity that retrieves context nodes from several sub RetrieverTools.
+
+class Retriever(BaseModel):
+    """An entity that retrieves context nodes from several sub RetrieverTools."""
+
+    id: str
+    """Unique identifier"""
+
+    name: str
+    """A name for the retriever tool.
+
+    Will default to the pipeline name if not provided.
     """
 
-    name: str = pydantic.Field(
-        description="A name for the retriever tool. Will default to the pipeline name if not provided."
-    )
-    pipelines: typing.Optional[typing.List[RetrieverPipeline]] = pydantic.Field(
-        description="The pipelines this retriever uses."
-    )
-    id: str = pydantic.Field(description="Unique identifier")
-    created_at: typing.Optional[dt.datetime]
-    updated_at: typing.Optional[dt.datetime]
-    project_id: str = pydantic.Field(description="The ID of the project this retriever resides in.")
-
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().dict(**kwargs_with_defaults)
-
-    class Config:
-        frozen = True
-        smart_union = True
-        json_encoders = {dt.datetime: serialize_datetime}
+    project_id: str
+    """The ID of the project this retriever resides in."""
+
+    created_at: Optional[datetime] = None
+    """Creation datetime"""
+
+    pipelines: Optional[List["RetrieverPipeline"]] = None
+    """The pipelines this retriever uses."""
+
+    updated_at: Optional[datetime] = None
+    """Update datetime"""
+
+
+from .retriever_pipeline import RetrieverPipeline

llama_cloud/types/retriever_create_params.py

@@ -0,0 +1,26 @@
+# 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__ = ["RetrieverCreateParams"]
+
+
+class RetrieverCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """A name for the retriever tool.
+
+    Will default to the pipeline name if not provided.
+    """
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    pipelines: Iterable["RetrieverPipelineParam"]
+    """The pipelines this retriever uses."""
+
+
+from .retriever_pipeline_param import RetrieverPipelineParam

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

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

llama_cloud/types/retriever_list_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypeAlias
+
+__all__ = ["RetrieverListResponse"]
+
+from .retriever import Retriever
+
+RetrieverListResponse: TypeAlias = List[Retriever]

llama_cloud/types/retriever_pipeline.py

@@ -1,37 +1,29 @@
-# This file was auto-generated by Fern from our API Definition.
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import datetime as dt
-import typing
+from __future__ import annotations
 
-from ..core.datetime_utils import serialize_datetime
-from .preset_retrieval_params import PresetRetrievalParams
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["RetrieverPipeline"]
+
+
+class RetrieverPipeline(BaseModel):
+    description: Optional[str] = None
+    """A description of the retriever tool."""
+
+    name: Optional[str] = None
+    """A name for the retriever tool.
 
-try:
-    import pydantic
-    if pydantic.__version__.startswith("1."):
-        raise ImportError
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
-
-
-class RetrieverPipeline(pydantic.BaseModel):
-    name: typing.Optional[str]
-    description: typing.Optional[str]
-    pipeline_id: str = pydantic.Field(description="The ID of the pipeline this tool uses.")
-    preset_retrieval_parameters: typing.Optional[PresetRetrievalParams] = pydantic.Field(
-        description="Parameters for retrieval configuration."
-    )
-
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().dict(**kwargs_with_defaults)
-
-    class Config:
-        frozen = True
-        smart_union = True
-        json_encoders = {dt.datetime: serialize_datetime}
+    Will default to the pipeline name if not provided.
+    """
+
+    pipeline_id: str
+    """The ID of the pipeline this tool uses."""
+
+    preset_retrieval_parameters: Optional["PresetRetrievalParams"] = None
+    """Parameters for retrieval configuration."""
+
+
+from .preset_retrieval_params import PresetRetrievalParams

llama_cloud/types/retriever_pipeline_param.py

@@ -0,0 +1,28 @@
+# 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__ = ["RetrieverPipelineParam"]
+
+
+class RetrieverPipelineParam(TypedDict, total=False):
+    description: Required[Optional[str]]
+    """A description of the retriever tool."""
+
+    name: Required[Optional[str]]
+    """A name for the retriever tool.
+
+    Will default to the pipeline name if not provided.
+    """
+
+    pipeline_id: Required[str]
+    """The ID of the pipeline this tool uses."""
+
+    preset_retrieval_parameters: "PresetRetrievalParamsParam"
+    """Parameters for retrieval configuration."""
+
+
+from .preset_retrieval_params_param import PresetRetrievalParamsParam

llama_cloud/types/retriever_search_params.py

@@ -0,0 +1,38 @@
+# 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 .re_rank_config_param import ReRankConfigParam
+from .composite_retrieval_mode import CompositeRetrievalMode
+
+__all__ = ["RetrieverSearchParams"]
+
+
+class RetrieverSearchParams(TypedDict, total=False):
+    query: Required[str]
+    """The query to retrieve against."""
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    mode: CompositeRetrievalMode
+    """The mode of composite retrieval."""
+
+    pipelines: Iterable["RetrieverPipelineParam"]
+    """The pipelines to use for retrieval."""
+
+    rerank_config: ReRankConfigParam
+    """The rerank configuration for composite retrieval."""
+
+    rerank_top_n: Optional[int]
+    """
+    (use rerank_config.top_n instead) The number of nodes to retrieve after
+    reranking over retrieved nodes from all retrieval tools.
+    """
+
+
+from .retriever_pipeline_param import RetrieverPipelineParam

llama_cloud/types/retriever_update_params.py

@@ -0,0 +1,19 @@
+# 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__ = ["RetrieverUpdateParams"]
+
+
+class RetrieverUpdateParams(TypedDict, total=False):
+    pipelines: Required[Optional[Iterable["RetrieverPipelineParam"]]]
+    """The pipelines this retriever uses."""
+
+    name: Optional[str]
+    """A name for the retriever."""
+
+
+from .retriever_pipeline_param import RetrieverPipelineParam

llama_cloud/types/retriever_upsert_params.py

@@ -0,0 +1,26 @@
+# 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__ = ["RetrieverUpsertParams"]
+
+
+class RetrieverUpsertParams(TypedDict, total=False):
+    name: Required[str]
+    """A name for the retriever tool.
+
+    Will default to the pipeline name if not provided.
+    """
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    pipelines: Iterable["RetrieverPipelineParam"]
+    """The pipelines this retriever uses."""
+
+
+from .retriever_pipeline_param import RetrieverPipelineParam

llama_cloud/types/retrievers/__init__.py

@@ -0,0 +1,5 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .retriever_search_params import RetrieverSearchParams as RetrieverSearchParams

llama_cloud/types/retrievers/retriever_search_params.py

@@ -0,0 +1,32 @@
+# 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 ..re_rank_config_param import ReRankConfigParam
+from ..composite_retrieval_mode import CompositeRetrievalMode
+
+__all__ = ["RetrieverSearchParams"]
+
+
+class RetrieverSearchParams(TypedDict, total=False):
+    query: Required[str]
+    """The query to retrieve against."""
+
+    organization_id: Optional[str]
+
+    project_id: Optional[str]
+
+    mode: CompositeRetrievalMode
+    """The mode of composite retrieval."""
+
+    rerank_config: ReRankConfigParam
+    """The rerank configuration for composite retrieval."""
+
+    rerank_top_n: Optional[int]
+    """
+    (use rerank_config.top_n instead) The number of nodes to retrieve after
+    reranking over retrieved nodes from all retrieval tools.
+    """

llama_cloud/types/shared/__init__.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .cloud_s3_data_source import CloudS3DataSource as CloudS3DataSource
+from .cloud_box_data_source import CloudBoxDataSource as CloudBoxDataSource
+from .cloud_jira_data_source import CloudJiraDataSource as CloudJiraDataSource
+from .cloud_slack_data_source import CloudSlackDataSource as CloudSlackDataSource
+from .failure_handling_config import FailureHandlingConfig as FailureHandlingConfig
+from .pg_vector_hnsw_settings import PgVectorHnswSettings as PgVectorHnswSettings
+from .cloud_jira_data_source_v2 import CloudJiraDataSourceV2 as CloudJiraDataSourceV2
+from .cloud_milvus_vector_store import CloudMilvusVectorStore as CloudMilvusVectorStore
+from .cloud_qdrant_vector_store import CloudQdrantVectorStore as CloudQdrantVectorStore
+from .cloud_astra_db_vector_store import CloudAstraDBVectorStore as CloudAstraDBVectorStore
+from .cloud_one_drive_data_source import CloudOneDriveDataSource as CloudOneDriveDataSource
+from .cloud_pinecone_vector_store import CloudPineconeVectorStore as CloudPineconeVectorStore
+from .cloud_postgres_vector_store import CloudPostgresVectorStore as CloudPostgresVectorStore
+from .cloud_confluence_data_source import CloudConfluenceDataSource as CloudConfluenceDataSource
+from .cloud_sharepoint_data_source import CloudSharepointDataSource as CloudSharepointDataSource
+from .cloud_notion_page_data_source import CloudNotionPageDataSource as CloudNotionPageDataSource
+from .cloud_az_storage_blob_data_source import CloudAzStorageBlobDataSource as CloudAzStorageBlobDataSource
+from .cloud_mongodb_atlas_vector_search import CloudMongoDBAtlasVectorSearch as CloudMongoDBAtlasVectorSearch
+from .cloud_azure_ai_search_vector_store import CloudAzureAISearchVectorStore as CloudAzureAISearchVectorStore

llama_cloud/types/shared/cloud_astra_db_vector_store.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["CloudAstraDBVectorStore"]
+
+
+class CloudAstraDBVectorStore(BaseModel):
+    """Cloud AstraDB Vector Store.
+
+    This class is used to store the configuration for an AstraDB vector store, so that it can be
+    created and used in LlamaCloud.
+
+    Args:
+        token (str): The Astra DB Application Token to use.
+        api_endpoint (str): The Astra DB JSON API endpoint for your database.
+        collection_name (str): Collection name to use. If not existing, it will be created.
+        embedding_dimension (int): Length of the embedding vectors in use.
+        keyspace (optional[str]): The keyspace to use. If not provided, 'default_keyspace'
+    """
+
+    api_endpoint: str
+    """The Astra DB JSON API endpoint for your database"""
+
+    collection_name: str
+    """Collection name to use. If not existing, it will be created"""
+
+    embedding_dimension: int
+    """Length of the embedding vectors in use"""
+
+    class_name: Optional[str] = None
+
+    keyspace: Optional[str] = None
+    """The keyspace to use. If not provided, 'default_keyspace'"""
+
+    supports_nested_metadata_filters: Optional[Literal[True]] = None

llama_cloud/types/shared/cloud_az_storage_blob_data_source.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["CloudAzStorageBlobDataSource"]
+
+
+class CloudAzStorageBlobDataSource(BaseModel):
+    account_url: str
+    """The Azure Storage Blob account URL to use for authentication."""
+
+    container_name: str
+    """The name of the Azure Storage Blob container to read from."""
+
+    account_name: Optional[str] = None
+    """The Azure Storage Blob account name to use for authentication."""
+
+    blob: Optional[str] = None
+    """The blob name to read from."""
+
+    class_name: Optional[str] = None
+
+    client_id: Optional[str] = None
+    """The Azure AD client ID to use for authentication."""
+
+    prefix: Optional[str] = None
+    """The prefix of the Azure Storage Blob objects to read from."""
+
+    supports_access_control: Optional[bool] = None
+
+    tenant_id: Optional[str] = None
+    """The Azure AD tenant ID to use for authentication."""

llama_cloud/types/shared/cloud_azure_ai_search_vector_store.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["CloudAzureAISearchVectorStore"]
+
+
+class CloudAzureAISearchVectorStore(BaseModel):
+    """Cloud Azure AI Search Vector Store."""
+
+    search_service_endpoint: str
+
+    class_name: Optional[str] = None
+
+    client_id: Optional[str] = None
+
+    embedding_dimension: Optional[int] = None
+
+    filterable_metadata_field_keys: Optional[Dict[str, object]] = None
+
+    index_name: Optional[str] = None
+
+    search_service_api_version: Optional[str] = None
+
+    supports_nested_metadata_filters: Optional[Literal[True]] = None
+
+    tenant_id: Optional[str] = None

llama_cloud/types/shared/cloud_box_data_source.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["CloudBoxDataSource"]
+
+
+class CloudBoxDataSource(BaseModel):
+    authentication_mechanism: Literal["developer_token", "ccg"]
+    """The type of authentication to use (Developer Token or CCG)"""
+
+    class_name: Optional[str] = None
+
+    client_id: Optional[str] = None
+    """
+    Box API key used for identifying the application the user is authenticating with
+    """
+
+    enterprise_id: Optional[str] = None
+    """Box Enterprise ID, if provided authenticates as service."""
+
+    folder_id: Optional[str] = None
+    """The ID of the Box folder to read from."""
+
+    supports_access_control: Optional[bool] = None
+
+    user_id: Optional[str] = None
+    """Box User ID, if provided authenticates as user."""

llama_cloud/types/shared/cloud_confluence_data_source.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+from .failure_handling_config import FailureHandlingConfig
+
+__all__ = ["CloudConfluenceDataSource"]
+
+
+class CloudConfluenceDataSource(BaseModel):
+    authentication_mechanism: str
+    """Type of Authentication for connecting to Confluence APIs."""
+
+    server_url: str
+    """The server URL of the Confluence instance."""
+
+    class_name: Optional[str] = None
+
+    cql: Optional[str] = None
+    """The CQL query to use for fetching pages."""
+
+    failure_handling: Optional[FailureHandlingConfig] = None
+    """Configuration for handling failures during processing.
+
+    Key-value object controlling failure handling behaviors.
+
+    Example: { "skip_list_failures": true }
+
+    Currently supports:
+
+    - skip_list_failures: Skip failed batches/lists and continue processing
+    """
+
+    index_restricted_pages: Optional[bool] = None
+    """Whether to index restricted pages."""
+
+    keep_markdown_format: Optional[bool] = None
+    """Whether to keep the markdown format."""
+
+    label: Optional[str] = None
+    """The label to use for fetching pages."""
+
+    page_ids: Optional[str] = None
+    """The page IDs of the Confluence to read from."""
+
+    space_key: Optional[str] = None
+    """The space key to read from."""
+
+    supports_access_control: Optional[bool] = None
+
+    user_name: Optional[str] = None
+    """The username to use for authentication."""