sdkagent

llama-parse-py API reference

153 public APIs from llama-parse-py (run-llama/llama-parse-py) — 133 classes, 8 functions, 12 methods. Signatures extracted by static analysis of the actual source.

Repository: run-llama/llama-parse-py

KindCount
Classes133
Functions8
Methods12

API list

classsrc.llama_cloud._base_client.BasePage
Defines the core interface for pagination.
funcsrc.llama_cloud._files.deepcopy_with_paths(item:_T, paths:Sequence[Sequence[str]]) -> _T
Copy only the containers along the given paths.
funcsrc.llama_cloud._models.build(base_model_cls:Callable[P, _BaseModelT], *args:P.args, **kwargs:P.kwargs) -> _BaseModelT
Construct a BaseModel class without validation.
funcsrc.llama_cloud._models.set_pydantic_config(typ:Any, config:pydantic.ConfigDict) -> None
Add a pydantic config for the given type.
classsrc.llama_cloud._polling.PollingError
Raised when a job fails during polling.
classsrc.llama_cloud._polling.PollingTimeoutError
Raised when polling times out before completion.
methodsrc.llama_cloud._streaming.Stream.close() -> None
Close the response and release the connection.
funcsrc.llama_cloud._utils._json.openapi_dumps(obj:Any) -> bytes
Serialize an object to UTF-8 encoded JSON bytes.
classsrc.llama_cloud._utils._resources_proxy.ResourcesProxy
A proxy for the `llama_cloud.resources` module.
funcsrc.llama_cloud._utils._typing.is_iterable_type(typ:type) -> bool
If the given type is `typing.Iterable[T]`
funcsrc.llama_cloud._utils._utils.quote(string:str) -> str
Add single quotation marks around the given string.
funcsrc.llama_cloud._utils._utils.removeprefix(string:str, prefix:str) -> str
Remove a prefix from a string.
funcsrc.llama_cloud._utils._utils.removesuffix(string:str, suffix:str) -> str
Remove a suffix from a string.
classsrc.llama_cloud.lib.index.base.LlamaCloudIndex
A managed index that stores documents in LlamaCloud.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.ainsert(document:Document, verbose:bool=False, **insert_kwargs:Any) -> None
Insert a document.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.as_retriever(**kwargs:Any) -> BaseRetriever
Return a Retriever for this managed index.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.aupdate_ref_doc(document:Document, verbose:bool=False, **update_kwargs:Any) -> None
Upserts a document and its corresponding nodes.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.aupload_file(file_path:str, custom_metadata:Optional[dict[str, Any]]=None, verbose:bool=False, wait_for_ingestion:bool=True, raise_on_error:bool=False) -> str
Upload a file to the index.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.build_index_from_nodes(nodes:Sequence[BaseNode], **build_kwargs:Any) -> IndexDict
Build the index from nodes.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.delete_nodes(node_ids:List[str], delete_from_docstore:bool=False, **delete_kwargs:Any) -> None
Delete a set of nodes.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.id() -> str
Return the pipeline (aka index) ID.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.insert(document:Document, verbose:bool=False, **insert_kwargs:Any) -> None
Insert a document.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.insert_nodes(nodes:Sequence[BaseNode], **insert_kwargs:Any) -> None
Insert a set of nodes.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.update_ref_doc(document:Document, verbose:bool=False, **update_kwargs:Any) -> None
Upserts a document and its corresponding nodes.
methodsrc.llama_cloud.lib.index.base.LlamaCloudIndex.upload_file(file_path:str, custom_metadata:Optional[dict[str, Any]]=None, verbose:bool=False, wait_for_ingestion:bool=True, raise_on_error:bool=False) -> str
Upload a file to the index.
classsrc.llama_cloud.types.b_box.BBox
Bounding box with coordinates and optional metadata.
classsrc.llama_cloud.types.batch_create_params.ConfigJob
Job to create for each file in the source directory.
classsrc.llama_cloud.types.batch_create_response.BatchCreateResponse
A top-level batch.
classsrc.llama_cloud.types.batch_create_response.Config
Batch configuration snapshot.
classsrc.llama_cloud.types.batch_create_response.ResultJobReference
Reference to a job produced by a batch.
classsrc.llama_cloud.types.batch_get_response.BatchGetResponse
A top-level batch.
classsrc.llama_cloud.types.batch_get_response.Config
Batch configuration snapshot.
classsrc.llama_cloud.types.batch_get_response.ConfigJob
Job to create for each file in the source directory.
classsrc.llama_cloud.types.batch_get_response.ResultJobReference
Reference to a job produced by a batch.
classsrc.llama_cloud.types.batch_list_response.BatchListResponse
A top-level batch.
classsrc.llama_cloud.types.batch_list_response.Config
Batch configuration snapshot.
classsrc.llama_cloud.types.batch_list_response.ConfigJob
Job to create for each file in the source directory.
classsrc.llama_cloud.types.batch_list_response.ResultJobReference
Reference to a job produced by a batch.
classsrc.llama_cloud.types.beta.agent_data.AgentData
API Result for a single agent data item
classsrc.llama_cloud.types.beta.batch_cancel_response.BatchCancelResponse
Response after cancelling a batch job.
classsrc.llama_cloud.types.beta.batch_create_response.BatchCreateResponse
Response schema for a batch processing job.
classsrc.llama_cloud.types.beta.batch_get_status_response.Job
Response schema for a batch processing job.
classsrc.llama_cloud.types.beta.batch_list_response.BatchListResponse
Response schema for a batch processing job.
classsrc.llama_cloud.types.beta.chat_create_response.JobMetadata
Token usage and status from the most recent run.
classsrc.llama_cloud.types.beta.chat_list_response.JobMetadata
Token usage and status from the most recent run.
classsrc.llama_cloud.types.beta.chat_retrieve_response.JobMetadata
Token usage and status from the most recent run.
classsrc.llama_cloud.types.beta.directories.file_add_response.FileAddResponse
API response schema for a directory file.
classsrc.llama_cloud.types.beta.directories.file_get_response.FileGetResponse
API response schema for a directory file.
classsrc.llama_cloud.types.beta.directories.file_list_response.FileListResponse
API response schema for a directory file.
classsrc.llama_cloud.types.beta.directories.file_update_response.FileUpdateResponse
API response schema for a directory file.
classsrc.llama_cloud.types.beta.directories.file_upload_response.FileUploadResponse
API response schema for a directory file.
classsrc.llama_cloud.types.beta.directory_create_response.DirectoryCreateResponse
API response schema for a directory.
classsrc.llama_cloud.types.beta.directory_get_response.DirectoryGetResponse
API response schema for a directory.
classsrc.llama_cloud.types.beta.directory_list_response.DirectoryListResponse
API response schema for a directory.
classsrc.llama_cloud.types.beta.directory_update_response.DirectoryUpdateResponse
API response schema for a directory.
classsrc.llama_cloud.types.beta.extracted_data.PageDimensions
Dimensions of a page in the source document.
classsrc.llama_cloud.types.beta.retrieval_find_response.RetrievalFindResponse
A file returned by find.
classsrc.llama_cloud.types.beta.retrieval_grep_response.RetrievalGrepResponse
A single grep match within a file.
classsrc.llama_cloud.types.beta.retrieval_read_response.RetrievalReadResponse
File read result.
classsrc.llama_cloud.types.beta.retrieval_retrieve_response.Result
A single retrieval result.
classsrc.llama_cloud.types.beta.retrieval_retrieve_response.RetrievalRetrieveResponse
Response containing retrieval results.
classsrc.llama_cloud.types.beta.sheets_job.Parameters
Job-time parameters such as webhook configurations.
classsrc.llama_cloud.types.beta.sheets_job.SheetsJob
A spreadsheet parsing job.
classsrc.llama_cloud.types.beta.sheets_job.WorksheetMetadata
Metadata about a worksheet in a spreadsheet
classsrc.llama_cloud.types.beta.split_category.SplitCategory
Category definition for document splitting.
classsrc.llama_cloud.types.beta.split_category_param.SplitCategoryParam
Category definition for document splitting.
classsrc.llama_cloud.types.beta.split_create_params.ConfigurationSplittingStrategy
Strategy for splitting documents.
classsrc.llama_cloud.types.beta.split_document_input.SplitDocumentInput
Document input specification for beta API.
classsrc.llama_cloud.types.beta.split_document_input_param.SplitDocumentInputParam
Document input specification for beta API.
classsrc.llama_cloud.types.beta.split_result_response.SplitResultResponse
Result of a completed split job.
classsrc.llama_cloud.types.beta.split_segment_response.SplitSegmentResponse
A segment of the split document.
classsrc.llama_cloud.types.classifier.classify_job.ClassifyJob
A classify job.
classsrc.llama_cloud.types.classifier.classify_job_param.ClassifyJobParam
A classify job.
classsrc.llama_cloud.types.classifier.job_get_results_response.Item
A file classification.
classsrc.llama_cloud.types.classifier.job_get_results_response.ItemResult
Result of classifying a single file.
classsrc.llama_cloud.types.classify_configuration.ClassifyConfiguration
Configuration for a classify job.
classsrc.llama_cloud.types.classify_configuration.ParsingConfiguration
Parsing configuration for classify jobs.
classsrc.llama_cloud.types.classify_configuration.Rule
A rule for classifying documents.
classsrc.llama_cloud.types.classify_configuration_param.ClassifyConfigurationParam
Configuration for a classify job.
classsrc.llama_cloud.types.classify_configuration_param.ParsingConfiguration
Parsing configuration for classify jobs.
classsrc.llama_cloud.types.classify_configuration_param.Rule
A rule for classifying documents.
classsrc.llama_cloud.types.classify_create_response.ClassifyCreateResponse
Response for a classify job.
classsrc.llama_cloud.types.classify_get_response.ClassifyGetResponse
Response for a classify job.
classsrc.llama_cloud.types.classify_list_response.ClassifyListResponse
Response for a classify job.
classsrc.llama_cloud.types.classify_result.ClassifyResult
Result of classifying a document.
classsrc.llama_cloud.types.classify_v2_parameters.ParsingConfiguration
Parsing configuration for classify jobs.
classsrc.llama_cloud.types.classify_v2_parameters.Rule
A rule for classifying documents.
classsrc.llama_cloud.types.classify_v2_parameters_param.ParsingConfiguration
Parsing configuration for classify jobs.
classsrc.llama_cloud.types.classify_v2_parameters_param.Rule
A rule for classifying documents.
classsrc.llama_cloud.types.data_sink.DataSink
Schema for a data sink.
classsrc.llama_cloud.types.data_sink_create_param.DataSinkCreateParam
Schema for creating a data sink.
classsrc.llama_cloud.types.data_source.DataSource
Schema for a data source.
classsrc.llama_cloud.types.extract_job_metadata.ExtractJobMetadata
Extraction metadata.
classsrc.llama_cloud.types.extract_job_usage.ExtractJobUsage
Extraction usage metrics.
classsrc.llama_cloud.types.extract_v2_job.ExtractV2Job
An extraction job.
classsrc.llama_cloud.types.extract_v2_job.Metadata
Job-level metadata.
classsrc.llama_cloud.types.extract_v2_job_query_response.ExtractV2JobQueryResponse
Paginated list of extraction jobs.
classsrc.llama_cloud.types.extract_v2_schema_validate_response.ExtractV2SchemaValidateResponse
Response schema for schema validation.
classsrc.llama_cloud.types.file.File
Schema for a file.
classsrc.llama_cloud.types.file_create_response.FileCreateResponse
An uploaded file.
classsrc.llama_cloud.types.file_list_response.FileListResponse
An uploaded file.
classsrc.llama_cloud.types.file_query_params.Filter
Filter parameters for file queries.
classsrc.llama_cloud.types.file_query_response.FileQueryResponse
Paginated list of files.
classsrc.llama_cloud.types.file_query_response.Item
An uploaded file.
classsrc.llama_cloud.types.form_list_text_item.FormListTextItem
One line of a form's list representation.
classsrc.llama_cloud.types.form_table_cell_items.FormTableCellItems
A table cell holding its own form nodes (e.g.
classsrc.llama_cloud.types.metadata_filters.MetadataFilters
Metadata filters for vector stores.
classsrc.llama_cloud.types.metadata_filters_param.MetadataFiltersParam
Metadata filters for vector stores.
classsrc.llama_cloud.types.page_figure_node_with_score.PageFigureNodeWithScore
Page figure metadata with score
classsrc.llama_cloud.types.page_screenshot_node_with_score.PageScreenshotNodeWithScore
Page screenshot metadata with score
classsrc.llama_cloud.types.parse_v2_parameters.ParseV2Parameters
Configuration for LlamaParse v2 document parsing.
classsrc.llama_cloud.types.parse_v2_parameters.ProcessingControlTimeouts
Timeout settings for job execution.
classsrc.llama_cloud.types.parse_v2_parameters_param.ProcessingControlTimeouts
Timeout settings for job execution.
classsrc.llama_cloud.types.parsing_create_params.ProcessingControlTimeouts
Timeout settings for job execution.
classsrc.llama_cloud.types.parsing_create_response.ParsingCreateResponse
A parse job.
classsrc.llama_cloud.types.parsing_get_response.Forms
Per-page form analysis results (one entry per page).
classsrc.llama_cloud.types.parsing_get_response.FormsPageFailedFormsPage
A page whose processing failed.
classsrc.llama_cloud.types.parsing_get_response.FormsPageFormsResultPage
Forms found on one page.
classsrc.llama_cloud.types.parsing_get_response.ImagesContentMetadata
Metadata for all extracted images.
classsrc.llama_cloud.types.parsing_get_response.ImagesContentMetadataImage
Metadata for a single extracted image.
classsrc.llama_cloud.types.parsing_get_response.ImagesContentMetadataImageBbox
Bounding box for an image on its page.
classsrc.llama_cloud.types.parsing_get_response.Items
Structured JSON result (if requested)
classsrc.llama_cloud.types.parsing_get_response.Job
Parse job status and metadata
classsrc.llama_cloud.types.parsing_get_response.Markdown
Markdown result (if requested)
classsrc.llama_cloud.types.parsing_get_response.Text
Plain text result (if requested)
classsrc.llama_cloud.types.parsing_list_response.ParsingListResponse
A parse job.
classsrc.llama_cloud.types.parsing_upload_file_response.ParsingUploadFileResponse
Response schema for a parse job.
classsrc.llama_cloud.types.pipeline.ConfigHash
Hashes for the configuration of a pipeline.
classsrc.llama_cloud.types.pipeline.EmbeddingModelConfig
Schema for an embedding model config.
classsrc.llama_cloud.types.pipeline.Pipeline
Schema for a pipeline.
classsrc.llama_cloud.types.pipelines.cloud_document.CloudDocument
Cloud document stored in S3.
classsrc.llama_cloud.types.pipelines.cloud_document_create_param.CloudDocumentCreateParam
Create a new cloud document.
classsrc.llama_cloud.types.pipelines.pipeline_data_source.PipelineDataSource
Schema for a data source in a pipeline.
classsrc.llama_cloud.types.pipelines.pipeline_file.PipelineFile
A file associated with a pipeline.
classsrc.llama_cloud.types.pipelines.text_node.TextNode
Provided for backward compatibility.
classsrc.llama_cloud.types.presigned_url.PresignedURL
Schema for a presigned URL.
classsrc.llama_cloud.types.project.Project
Schema for a project.
classsrc.llama_cloud.types.shared.cloud_astra_db_vector_store.CloudAstraDBVectorStore
Cloud AstraDB Vector Store.
classsrc.llama_cloud.types.shared.cloud_azure_ai_search_vector_store.CloudAzureAISearchVectorStore
Cloud Azure AI Search Vector Store.
classsrc.llama_cloud.types.shared.cloud_milvus_vector_store.CloudMilvusVectorStore
Cloud Milvus Vector Store.
classsrc.llama_cloud.types.shared.cloud_mongodb_atlas_vector_search.CloudMongoDBAtlasVectorSearch
Cloud MongoDB Atlas Vector Store.
classsrc.llama_cloud.types.shared.cloud_pinecone_vector_store.CloudPineconeVectorStore
Cloud Pinecone Vector Store.
classsrc.llama_cloud.types.shared.cloud_qdrant_vector_store.CloudQdrantVectorStore
Cloud Qdrant Vector Store.
classsrc.llama_cloud.types.shared.pg_vector_hnsw_settings.PgVectorHnswSettings
HNSW settings for PGVector.
classsrc.llama_cloud.types.shared_params.cloud_astra_db_vector_store.CloudAstraDBVectorStore
Cloud AstraDB Vector Store.
classsrc.llama_cloud.types.shared_params.cloud_azure_ai_search_vector_store.CloudAzureAISearchVectorStore
Cloud Azure AI Search Vector Store.
classsrc.llama_cloud.types.shared_params.cloud_milvus_vector_store.CloudMilvusVectorStore
Cloud Milvus Vector Store.
classsrc.llama_cloud.types.shared_params.cloud_mongodb_atlas_vector_search.CloudMongoDBAtlasVectorSearch
Cloud MongoDB Atlas Vector Store.
classsrc.llama_cloud.types.shared_params.cloud_pinecone_vector_store.CloudPineconeVectorStore
Cloud Pinecone Vector Store.
classsrc.llama_cloud.types.shared_params.cloud_qdrant_vector_store.CloudQdrantVectorStore
Cloud Qdrant Vector Store.
classsrc.llama_cloud.types.shared_params.pg_vector_hnsw_settings.PgVectorHnswSettings
HNSW settings for PGVector.
classsrc.llama_cloud.types.split_v1_parameters.SplittingStrategy
Strategy for splitting documents.
classsrc.llama_cloud.types.split_v1_parameters_param.SplittingStrategy
Strategy for splitting documents.

About this data

These signatures were extracted from the public source of run-llama/llama-parse-py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries