llama-cloud 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

llama_cloud/types/__init__.py

@@ -15,6 +15,7 @@ from .advanced_mode_transform_config_segmentation_config import (
     AdvancedModeTransformConfigSegmentationConfig_None,
     AdvancedModeTransformConfigSegmentationConfig_Page,
 )
+from .app_schema_chat_chat_message import AppSchemaChatChatMessage
 from .auto_transform_config import AutoTransformConfig
 from .azure_open_ai_embedding import AzureOpenAiEmbedding
 from .azure_open_ai_embedding_config import AzureOpenAiEmbeddingConfig
@@ -25,8 +26,9 @@ from .bedrock_embedding_config import BedrockEmbeddingConfig
 from .box_auth_mechanism import BoxAuthMechanism
 from .character_chunking_config import CharacterChunkingConfig
 from .character_splitter import CharacterSplitter
+from .chat_app import ChatApp
+from .chat_app_response import ChatAppResponse
 from .chat_data import ChatData
-from .chat_message import ChatMessage
 from .cloud_az_storage_blob_data_source import CloudAzStorageBlobDataSource
 from .cloud_azure_ai_search_vector_store import CloudAzureAiSearchVectorStore
 from .cloud_box_data_source import CloudBoxDataSource
@@ -48,6 +50,9 @@ from .cloud_slack_data_source import CloudSlackDataSource
 from .code_splitter import CodeSplitter
 from .cohere_embedding import CohereEmbedding
 from .cohere_embedding_config import CohereEmbeddingConfig
+from .composite_retrieval_mode import CompositeRetrievalMode
+from .composite_retrieval_result import CompositeRetrievalResult
+from .composite_retrieved_text_node import CompositeRetrievedTextNode
 from .configurable_data_sink_names import ConfigurableDataSinkNames
 from .configurable_data_source_names import ConfigurableDataSourceNames
 from .configurable_transformation_definition import ConfigurableTransformationDefinition
@@ -66,6 +71,7 @@ from .data_source_create_component import DataSourceCreateComponent
 from .data_source_create_custom_metadata_value import DataSourceCreateCustomMetadataValue
 from .data_source_custom_metadata_value import DataSourceCustomMetadataValue
 from .data_source_definition import DataSourceDefinition
+from .edit_suggestion import EditSuggestion
 from .element_segmentation_config import ElementSegmentationConfig
 from .embedding_model_config import EmbeddingModelConfig
 from .embedding_model_config_embedding_config import (
@@ -98,12 +104,25 @@ from .eval_metric import EvalMetric
 from .eval_question import EvalQuestion
 from .eval_question_create import EvalQuestionCreate
 from .eval_question_result import EvalQuestionResult
+from .extract_agent import ExtractAgent
+from .extract_agent_data_schema_value import ExtractAgentDataSchemaValue
+from .extract_config import ExtractConfig
+from .extract_job import ExtractJob
+from .extract_job_create import ExtractJobCreate
+from .extract_job_create_data_schema_override_value import ExtractJobCreateDataSchemaOverrideValue
+from .extract_mode import ExtractMode
+from .extract_resultset import ExtractResultset
+from .extract_resultset_data import ExtractResultsetData
+from .extract_resultset_data_item_value import ExtractResultsetDataItemValue
+from .extract_resultset_data_zero_value import ExtractResultsetDataZeroValue
+from .extract_resultset_extraction_metadata_value import ExtractResultsetExtractionMetadataValue
 from .extraction_job import ExtractionJob
 from .extraction_result import ExtractionResult
 from .extraction_result_data_value import ExtractionResultDataValue
 from .extraction_schema import ExtractionSchema
 from .extraction_schema_data_schema_value import ExtractionSchemaDataSchemaValue
 from .file import File
+from .file_permission_info_value import FilePermissionInfoValue
 from .file_resource_info_value import FileResourceInfoValue
 from .filter_condition import FilterCondition
 from .filter_operator import FilterOperator
@@ -113,10 +132,20 @@ from .http_validation_error import HttpValidationError
 from .hugging_face_inference_api_embedding import HuggingFaceInferenceApiEmbedding
 from .hugging_face_inference_api_embedding_config import HuggingFaceInferenceApiEmbeddingConfig
 from .hugging_face_inference_api_embedding_token import HuggingFaceInferenceApiEmbeddingToken
+from .image_block import ImageBlock
 from .ingestion_error_response import IngestionErrorResponse
 from .input_message import InputMessage
 from .interval_usage_and_plan import IntervalUsageAndPlan
 from .job_name_mapping import JobNameMapping
+from .job_names import JobNames
+from .job_record import JobRecord
+from .job_record_with_usage_metrics import JobRecordWithUsageMetrics
+from .llama_index_core_base_llms_types_chat_message import LlamaIndexCoreBaseLlmsTypesChatMessage
+from .llama_index_core_base_llms_types_chat_message_blocks_item import (
+    LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem,
+    LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem_Image,
+    LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem_Text,
+)
 from .llama_parse_parameters import LlamaParseParameters
 from .llama_parse_supported_file_extensions import LlamaParseSupportedFileExtensions
 from .llm import Llm
@@ -149,12 +178,16 @@ from .page_screenshot_metadata import PageScreenshotMetadata
 from .page_screenshot_node_with_score import PageScreenshotNodeWithScore
 from .page_segmentation_config import PageSegmentationConfig
 from .page_splitter_node_parser import PageSplitterNodeParser
+from .paginated_jobs_history_with_metrics import PaginatedJobsHistoryWithMetrics
 from .paginated_list_pipeline_files_response import PaginatedListPipelineFilesResponse
+from .paginated_report_response import PaginatedReportResponse
+from .parse_plan_level import ParsePlanLevel
 from .parser_languages import ParserLanguages
 from .parsing_history_item import ParsingHistoryItem
 from .parsing_job import ParsingJob
 from .parsing_job_json_result import ParsingJobJsonResult
 from .parsing_job_markdown_result import ParsingJobMarkdownResult
+from .parsing_job_structured_result import ParsingJobStructuredResult
 from .parsing_job_text_result import ParsingJobTextResult
 from .parsing_usage import ParsingUsage
 from .partition_names import PartitionNames
@@ -193,6 +226,7 @@ from .pipeline_file_config_hash_value import PipelineFileConfigHashValue
 from .pipeline_file_create import PipelineFileCreate
 from .pipeline_file_create_custom_metadata_value import PipelineFileCreateCustomMetadataValue
 from .pipeline_file_custom_metadata_value import PipelineFileCustomMetadataValue
+from .pipeline_file_permission_info_value import PipelineFilePermissionInfoValue
 from .pipeline_file_resource_info_value import PipelineFileResourceInfoValue
 from .pipeline_transform_config import (
     PipelineTransformConfig,
@@ -205,14 +239,40 @@ from .playground_session import PlaygroundSession
 from .pooling import Pooling
 from .preset_retrieval_params import PresetRetrievalParams
 from .presigned_url import PresignedUrl
+from .progress_event import ProgressEvent
+from .progress_event_status import ProgressEventStatus
 from .project import Project
 from .project_create import ProjectCreate
 from .prompt_mixin_prompts import PromptMixinPrompts
 from .prompt_spec import PromptSpec
 from .pydantic_program_mode import PydanticProgramMode
 from .related_node_info import RelatedNodeInfo
+from .related_node_info_node_type import RelatedNodeInfoNodeType
+from .report import Report
+from .report_block import ReportBlock
+from .report_block_dependency import ReportBlockDependency
+from .report_create_response import ReportCreateResponse
+from .report_event_item import ReportEventItem
+from .report_event_item_event_data import (
+    ReportEventItemEventData,
+    ReportEventItemEventData_Progress,
+    ReportEventItemEventData_ReportBlockUpdate,
+    ReportEventItemEventData_ReportStateUpdate,
+)
+from .report_event_type import ReportEventType
+from .report_metadata import ReportMetadata
+from .report_plan import ReportPlan
+from .report_plan_block import ReportPlanBlock
+from .report_query import ReportQuery
+from .report_response import ReportResponse
+from .report_state import ReportState
+from .report_state_event import ReportStateEvent
+from .report_update_event import ReportUpdateEvent
 from .retrieval_mode import RetrievalMode
 from .retrieve_results import RetrieveResults
+from .retriever import Retriever
+from .retriever_create import RetrieverCreate
+from .retriever_pipeline import RetrieverPipeline
 from .role import Role
 from .semantic_chunking_config import SemanticChunkingConfig
 from .sentence_chunking_config import SentenceChunkingConfig
@@ -220,6 +280,7 @@ from .sentence_splitter import SentenceSplitter
 from .status_enum import StatusEnum
 from .supported_llm_model import SupportedLlmModel
 from .supported_llm_model_names import SupportedLlmModelNames
+from .text_block import TextBlock
 from .text_node import TextNode
 from .text_node_relationships_value import TextNodeRelationshipsValue
 from .text_node_with_score import TextNodeWithScore
@@ -227,6 +288,8 @@ from .token_chunking_config import TokenChunkingConfig
 from .token_text_splitter import TokenTextSplitter
 from .transformation_category_names import TransformationCategoryNames
 from .usage import Usage
+from .usage_metric_response import UsageMetricResponse
+from .user_job_record import UserJobRecord
 from .user_organization import UserOrganization
 from .user_organization_create import UserOrganizationCreate
 from .user_organization_delete import UserOrganizationDelete
@@ -249,6 +312,7 @@ __all__ = [
     "AdvancedModeTransformConfigSegmentationConfig_Element",
     "AdvancedModeTransformConfigSegmentationConfig_None",
     "AdvancedModeTransformConfigSegmentationConfig_Page",
+    "AppSchemaChatChatMessage",
     "AutoTransformConfig",
     "AzureOpenAiEmbedding",
     "AzureOpenAiEmbeddingConfig",
@@ -259,8 +323,9 @@ __all__ = [
     "BoxAuthMechanism",
     "CharacterChunkingConfig",
     "CharacterSplitter",
+    "ChatApp",
+    "ChatAppResponse",
     "ChatData",
-    "ChatMessage",
     "CloudAzStorageBlobDataSource",
     "CloudAzureAiSearchVectorStore",
     "CloudBoxDataSource",
@@ -282,6 +347,9 @@ __all__ = [
     "CodeSplitter",
     "CohereEmbedding",
     "CohereEmbeddingConfig",
+    "CompositeRetrievalMode",
+    "CompositeRetrievalResult",
+    "CompositeRetrievedTextNode",
     "ConfigurableDataSinkNames",
     "ConfigurableDataSourceNames",
     "ConfigurableTransformationDefinition",
@@ -300,6 +368,7 @@ __all__ = [
     "DataSourceCreateCustomMetadataValue",
     "DataSourceCustomMetadataValue",
     "DataSourceDefinition",
+    "EditSuggestion",
     "ElementSegmentationConfig",
     "EmbeddingModelConfig",
     "EmbeddingModelConfigEmbeddingConfig",
@@ -328,12 +397,25 @@ __all__ = [
     "EvalQuestion",
     "EvalQuestionCreate",
     "EvalQuestionResult",
+    "ExtractAgent",
+    "ExtractAgentDataSchemaValue",
+    "ExtractConfig",
+    "ExtractJob",
+    "ExtractJobCreate",
+    "ExtractJobCreateDataSchemaOverrideValue",
+    "ExtractMode",
+    "ExtractResultset",
+    "ExtractResultsetData",
+    "ExtractResultsetDataItemValue",
+    "ExtractResultsetDataZeroValue",
+    "ExtractResultsetExtractionMetadataValue",
     "ExtractionJob",
     "ExtractionResult",
     "ExtractionResultDataValue",
     "ExtractionSchema",
     "ExtractionSchemaDataSchemaValue",
     "File",
+    "FilePermissionInfoValue",
     "FileResourceInfoValue",
     "FilterCondition",
     "FilterOperator",
@@ -343,10 +425,18 @@ __all__ = [
     "HuggingFaceInferenceApiEmbedding",
     "HuggingFaceInferenceApiEmbeddingConfig",
     "HuggingFaceInferenceApiEmbeddingToken",
+    "ImageBlock",
     "IngestionErrorResponse",
     "InputMessage",
     "IntervalUsageAndPlan",
     "JobNameMapping",
+    "JobNames",
+    "JobRecord",
+    "JobRecordWithUsageMetrics",
+    "LlamaIndexCoreBaseLlmsTypesChatMessage",
+    "LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem",
+    "LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem_Image",
+    "LlamaIndexCoreBaseLlmsTypesChatMessageBlocksItem_Text",
     "LlamaParseParameters",
     "LlamaParseSupportedFileExtensions",
     "Llm",
@@ -379,12 +469,16 @@ __all__ = [
     "PageScreenshotNodeWithScore",
     "PageSegmentationConfig",
     "PageSplitterNodeParser",
+    "PaginatedJobsHistoryWithMetrics",
     "PaginatedListPipelineFilesResponse",
+    "PaginatedReportResponse",
+    "ParsePlanLevel",
     "ParserLanguages",
     "ParsingHistoryItem",
     "ParsingJob",
     "ParsingJobJsonResult",
     "ParsingJobMarkdownResult",
+    "ParsingJobStructuredResult",
     "ParsingJobTextResult",
     "ParsingUsage",
     "PartitionNames",
@@ -419,6 +513,7 @@ __all__ = [
     "PipelineFileCreate",
     "PipelineFileCreateCustomMetadataValue",
     "PipelineFileCustomMetadataValue",
+    "PipelineFilePermissionInfoValue",
     "PipelineFileResourceInfoValue",
     "PipelineTransformConfig",
     "PipelineTransformConfig_Advanced",
@@ -429,14 +524,38 @@ __all__ = [
     "Pooling",
     "PresetRetrievalParams",
     "PresignedUrl",
+    "ProgressEvent",
+    "ProgressEventStatus",
     "Project",
     "ProjectCreate",
     "PromptMixinPrompts",
     "PromptSpec",
     "PydanticProgramMode",
     "RelatedNodeInfo",
+    "RelatedNodeInfoNodeType",
+    "Report",
+    "ReportBlock",
+    "ReportBlockDependency",
+    "ReportCreateResponse",
+    "ReportEventItem",
+    "ReportEventItemEventData",
+    "ReportEventItemEventData_Progress",
+    "ReportEventItemEventData_ReportBlockUpdate",
+    "ReportEventItemEventData_ReportStateUpdate",
+    "ReportEventType",
+    "ReportMetadata",
+    "ReportPlan",
+    "ReportPlanBlock",
+    "ReportQuery",
+    "ReportResponse",
+    "ReportState",
+    "ReportStateEvent",
+    "ReportUpdateEvent",
     "RetrievalMode",
     "RetrieveResults",
+    "Retriever",
+    "RetrieverCreate",
+    "RetrieverPipeline",
     "Role",
     "SemanticChunkingConfig",
     "SentenceChunkingConfig",
@@ -444,6 +563,7 @@ __all__ = [
     "StatusEnum",
     "SupportedLlmModel",
     "SupportedLlmModelNames",
+    "TextBlock",
     "TextNode",
     "TextNodeRelationshipsValue",
     "TextNodeWithScore",
@@ -451,6 +571,8 @@ __all__ = [
     "TokenTextSplitter",
     "TransformationCategoryNames",
     "Usage",
+    "UsageMetricResponse",
+    "UserJobRecord",
     "UserOrganization",
     "UserOrganizationCreate",
     "UserOrganizationDelete",

llama_cloud/types/{chat_message.py → app_schema_chat_chat_message.py}

@@ -16,13 +16,13 @@ except ImportError:
     import pydantic  # type: ignore
 
 
-class ChatMessage(pydantic.BaseModel):
+class AppSchemaChatChatMessage(pydantic.BaseModel):
     id: str
     index: int = pydantic.Field(description="The index of the message in the chat.")
     annotations: typing.Optional[typing.List[MessageAnnotation]] = pydantic.Field(
         description="Retrieval annotations for the message."
     )
-    role: MessageRole
+    role: MessageRole = pydantic.Field(description="The role of the message.")
     content: typing.Optional[str]
     additional_kwargs: typing.Optional[typing.Dict[str, str]] = pydantic.Field(
         description="Additional arguments passed to the model"

llama_cloud/types/chat_app.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .llm_parameters import LlmParameters
+from .preset_retrieval_params import PresetRetrievalParams
+
+try:
+    import pydantic
+    if pydantic.__version__.startswith("1."):
+        raise ImportError
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ChatApp(pydantic.BaseModel):
+    """
+    Schema for a chat app
+    """
+
+    id: str
+    name: str
+    pipeline_id: str
+    project_id: str
+    llm_config: LlmParameters
+    retrieval_config: PresetRetrievalParams
+    created_at: dt.datetime
+    updated_at: dt.datetime
+
+    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}

llama_cloud/types/chat_app_response.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .llm_parameters import LlmParameters
+from .preset_retrieval_params import PresetRetrievalParams
+
+try:
+    import pydantic
+    if pydantic.__version__.startswith("1."):
+        raise ImportError
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ChatAppResponse(pydantic.BaseModel):
+    id: str
+    name: str
+    pipeline_id: str
+    project_id: str
+    llm_config: LlmParameters
+    retrieval_config: PresetRetrievalParams
+    created_at: dt.datetime
+    updated_at: dt.datetime
+    pipeline_name: str
+
+    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}

llama_cloud/types/cloud_az_storage_blob_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudAzStorageBlobDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     container_name: str = pydantic.Field(description="The name of the Azure Storage Blob container to read from.")
     account_url: str = pydantic.Field(description="The Azure Storage Blob account URL to use for authentication.")
     blob: typing.Optional[str]

llama_cloud/types/cloud_box_data_source.py

@@ -16,6 +16,7 @@ except ImportError:
 
 
 class CloudBoxDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     folder_id: typing.Optional[str]
     authentication_mechanism: BoxAuthMechanism = pydantic.Field(
         description="The type of authentication to use (Developer Token or CCG)"

llama_cloud/types/cloud_confluence_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudConfluenceDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     server_url: str = pydantic.Field(description="The server URL of the Confluence instance.")
     authentication_mechanism: str = pydantic.Field(
         description="Type of Authentication for connecting to Confluence APIs."

llama_cloud/types/cloud_google_drive_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudGoogleDriveDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     folder_id: str = pydantic.Field(description="The ID of the Google Drive folder to read from.")
     service_account_key: typing.Dict[str, typing.Any] = pydantic.Field(
         description="The service account key JSON to use for authentication."

llama_cloud/types/cloud_jira_data_source.py

@@ -19,6 +19,7 @@ class CloudJiraDataSource(pydantic.BaseModel):
     Cloud Jira Data Source integrating JiraReader.
     """
 
+    supports_access_control: typing.Optional[bool]
     email: typing.Optional[str]
     api_token: typing.Optional[str]
     server_url: typing.Optional[str]

llama_cloud/types/cloud_notion_page_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudNotionPageDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     integration_token: str = pydantic.Field(description="The integration token to use for authentication.")
     database_ids: typing.Optional[str]
     page_ids: typing.Optional[str]

llama_cloud/types/cloud_one_drive_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudOneDriveDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     user_principal_name: str = pydantic.Field(description="The user principal name to use for authentication.")
     folder_path: typing.Optional[str]
     folder_id: typing.Optional[str]

llama_cloud/types/cloud_postgres_vector_store.py

@@ -25,6 +25,7 @@ class CloudPostgresVectorStore(pydantic.BaseModel):
     schema_name: str
     embed_dim: int
     hybrid_search: typing.Optional[bool]
+    perform_setup: typing.Optional[bool]
     class_name: typing.Optional[str]
 
     def json(self, **kwargs: typing.Any) -> str:

llama_cloud/types/cloud_s_3_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudS3DataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     bucket: str = pydantic.Field(description="The name of the S3 bucket to read from.")
     prefix: typing.Optional[str]
     aws_access_id: typing.Optional[str]

llama_cloud/types/cloud_sharepoint_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudSharepointDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     site_name: typing.Optional[str]
     site_id: typing.Optional[str]
     folder_path: typing.Optional[str]

llama_cloud/types/cloud_slack_data_source.py

@@ -15,6 +15,7 @@ except ImportError:
 
 
 class CloudSlackDataSource(pydantic.BaseModel):
+    supports_access_control: typing.Optional[bool]
     slack_token: str = pydantic.Field(description="Slack Bot Token.")
     channel_ids: typing.Optional[str]
     latest_date: typing.Optional[str]

llama_cloud/types/composite_retrieval_mode.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class CompositeRetrievalMode(str, enum.Enum):
+    """
+    Enum for the mode of composite retrieval.
+    """
+
+    ROUTING = "routing"
+    FULL = "full"
+
+    def visit(self, routing: typing.Callable[[], T_Result], full: typing.Callable[[], T_Result]) -> T_Result:
+        if self is CompositeRetrievalMode.ROUTING:
+            return routing()
+        if self is CompositeRetrievalMode.FULL:
+            return full()

llama_cloud/types/composite_retrieval_result.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .composite_retrieved_text_node import CompositeRetrievedTextNode
+from .page_screenshot_node_with_score import PageScreenshotNodeWithScore
+
+try:
+    import pydantic
+    if pydantic.__version__.startswith("1."):
+        raise ImportError
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class CompositeRetrievalResult(pydantic.BaseModel):
+    nodes: typing.Optional[typing.List[CompositeRetrievedTextNode]] = pydantic.Field(
+        description="The retrieved nodes from the composite retrieval."
+    )
+    image_nodes: typing.Optional[typing.List[PageScreenshotNodeWithScore]] = pydantic.Field(
+        description="The image nodes retrieved by the pipeline for the given query."
+    )
+
+    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}

llama_cloud/types/composite_retrieved_text_node.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+
+try:
+    import pydantic
+    if pydantic.__version__.startswith("1."):
+        raise ImportError
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class CompositeRetrievedTextNode(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The ID of the retrieved node.")
+    retriever_id: str = pydantic.Field(description="The ID of the retriever this node was retrieved from.")
+    retriever_pipeline_name: str = pydantic.Field(
+        description="The name of the retrieval pipeline this node was retrieved from."
+    )
+    pipeline_id: str = pydantic.Field(description="The ID of the pipeline this node was retrieved from.")
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
+        description="Metadata associated with the retrieved node."
+    )
+    text: str = pydantic.Field(description="The text of the retrieved node.")
+    start_char_idx: typing.Optional[int]
+    end_char_idx: typing.Optional[int]
+
+    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}

llama_cloud/types/data_sink.py

@@ -26,7 +26,7 @@ class DataSink(pydantic.BaseModel):
     updated_at: typing.Optional[dt.datetime]
     name: str = pydantic.Field(description="The name of the data sink.")
     sink_type: ConfigurableDataSinkNames
-    component: DataSinkComponent
+    component: DataSinkComponent = pydantic.Field(description="Component that implements the data sink")
     project_id: str
 
     def json(self, **kwargs: typing.Any) -> str:

llama_cloud/types/data_sink_create.py

@@ -23,7 +23,7 @@ class DataSinkCreate(pydantic.BaseModel):
 
     name: str = pydantic.Field(description="The name of the data sink.")
     sink_type: ConfigurableDataSinkNames
-    component: DataSinkCreateComponent
+    component: DataSinkCreateComponent = pydantic.Field(description="Component that implements the data sink")
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

llama_cloud/types/data_source.py

@@ -28,7 +28,7 @@ class DataSource(pydantic.BaseModel):
     name: str = pydantic.Field(description="The name of the data source.")
     source_type: ConfigurableDataSourceNames
     custom_metadata: typing.Optional[typing.Dict[str, typing.Optional[DataSourceCustomMetadataValue]]]
-    component: DataSourceComponent
+    component: DataSourceComponent = pydantic.Field(description="Component that implements the data source")
     project_id: str
 
     def json(self, **kwargs: typing.Any) -> str:

llama_cloud/types/data_source_create.py

@@ -25,7 +25,7 @@ class DataSourceCreate(pydantic.BaseModel):
     name: str = pydantic.Field(description="The name of the data source.")
     source_type: ConfigurableDataSourceNames
     custom_metadata: typing.Optional[typing.Dict[str, typing.Optional[DataSourceCreateCustomMetadataValue]]]
-    component: DataSourceCreateComponent
+    component: DataSourceCreateComponent = pydantic.Field(description="Component that implements the data source")
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}