From e90938ff33733bfcfd840d7f929b583f77f4cc71 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 00:51:57 +0000 Subject: [PATCH] SDK regeneration --- .fern/metadata.json | 2 +- reference.md | 4 ++-- src/runcaptain/client.py | 16 ++++------------ src/runcaptain/indexing/client.py | 8 ++++---- src/runcaptain/indexing/raw_client.py | 8 ++++---- 5 files changed, 15 insertions(+), 23 deletions(-) diff --git a/.fern/metadata.json b/.fern/metadata.json index ef6aa0d..aba6e88 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,5 +1,5 @@ { - "cliVersion": "3.86.0", + "cliVersion": "4.0.1", "generatorName": "fernapi/fern-python-sdk", "generatorVersion": "4.59.4", "generatorConfig": { diff --git a/reference.md b/reference.md index f5e5b0d..0213529 100644 --- a/reference.md +++ b/reference.md @@ -2358,7 +2358,7 @@ You can provide either: - `url` — a single URL string for one document - `urls` — an array of URL strings for multiple documents -Supported file types include PDF, TXT, DOCX, CSV, XLSX, and more. Documents are downloaded and processed through the same pipeline as cloud storage indexing. +Supported file types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Documents are downloaded and processed through the same pipeline as cloud storage indexing. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}. @@ -2421,7 +2421,7 @@ client.indexing.index_url_v2(
-**url:** `typing.Optional[str]` — A single public URL to a hosted document (PDF, TXT, DOCX, etc.). Provide either 'url' or 'urls', not both. +**url:** `typing.Optional[str]` — A single public URL to a hosted document. Supported types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Provide either 'url' or 'urls', not both.
diff --git a/src/runcaptain/client.py b/src/runcaptain/client.py index 6ef8f91..e37282b 100644 --- a/src/runcaptain/client.py +++ b/src/runcaptain/client.py @@ -37,7 +37,7 @@ class Captain: - organization_id : typing.Optional[str] + organization_id : str key : typing.Optional[typing.Union[str, typing.Callable[[], str]]] headers : typing.Optional[typing.Dict[str, str]] Additional headers to send with every request. @@ -69,7 +69,7 @@ def __init__( *, base_url: typing.Optional[str] = None, environment: CaptainEnvironment = CaptainEnvironment.DEFAULT, - organization_id: typing.Optional[str] = os.getenv("CAPTAIN_ORGANIZATION_ID"), + organization_id: str, key: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("CAPTAIN_API_KEY"), headers: typing.Optional[typing.Dict[str, str]] = None, timeout: typing.Optional[float] = None, @@ -80,10 +80,6 @@ def __init__( _defaulted_timeout = ( timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read ) - if organization_id is None: - raise ApiError( - body="The client must be instantiated be either passing in organization_id or setting CAPTAIN_ORGANIZATION_ID" - ) if key is None: raise ApiError(body="The client must be instantiated be either passing in key or setting CAPTAIN_API_KEY") self._client_wrapper = SyncClientWrapper( @@ -164,7 +160,7 @@ class AsyncCaptain: - organization_id : typing.Optional[str] + organization_id : str key : typing.Optional[typing.Union[str, typing.Callable[[], str]]] headers : typing.Optional[typing.Dict[str, str]] Additional headers to send with every request. @@ -196,7 +192,7 @@ def __init__( *, base_url: typing.Optional[str] = None, environment: CaptainEnvironment = CaptainEnvironment.DEFAULT, - organization_id: typing.Optional[str] = os.getenv("CAPTAIN_ORGANIZATION_ID"), + organization_id: str, key: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = os.getenv("CAPTAIN_API_KEY"), headers: typing.Optional[typing.Dict[str, str]] = None, timeout: typing.Optional[float] = None, @@ -207,10 +203,6 @@ def __init__( _defaulted_timeout = ( timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read ) - if organization_id is None: - raise ApiError( - body="The client must be instantiated be either passing in organization_id or setting CAPTAIN_ORGANIZATION_ID" - ) if key is None: raise ApiError(body="The client must be instantiated be either passing in key or setting CAPTAIN_API_KEY") self._client_wrapper = AsyncClientWrapper( diff --git a/src/runcaptain/indexing/client.py b/src/runcaptain/indexing/client.py index 6a63666..91fed1a 100644 --- a/src/runcaptain/indexing/client.py +++ b/src/runcaptain/indexing/client.py @@ -1037,7 +1037,7 @@ def index_url_v2( - `url` — a single URL string for one document - `urls` — an array of URL strings for multiple documents - Supported file types include PDF, TXT, DOCX, CSV, XLSX, and more. Documents are downloaded and processed through the same pipeline as cloud storage indexing. + Supported file types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Documents are downloaded and processed through the same pipeline as cloud storage indexing. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}. @@ -1049,7 +1049,7 @@ def index_url_v2( Document processing type. 'advanced' uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. 'basic' provides reliable OCR optimized for general document indexing and high-volume processing. url : typing.Optional[str] - A single public URL to a hosted document (PDF, TXT, DOCX, etc.). Provide either 'url' or 'urls', not both. + A single public URL to a hosted document. Supported types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Provide either 'url' or 'urls', not both. urls : typing.Optional[typing.Sequence[str]] An array of public URLs to hosted documents. Provide either 'url' or 'urls', not both. @@ -2196,7 +2196,7 @@ async def index_url_v2( - `url` — a single URL string for one document - `urls` — an array of URL strings for multiple documents - Supported file types include PDF, TXT, DOCX, CSV, XLSX, and more. Documents are downloaded and processed through the same pipeline as cloud storage indexing. + Supported file types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Documents are downloaded and processed through the same pipeline as cloud storage indexing. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}. @@ -2208,7 +2208,7 @@ async def index_url_v2( Document processing type. 'advanced' uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. 'basic' provides reliable OCR optimized for general document indexing and high-volume processing. url : typing.Optional[str] - A single public URL to a hosted document (PDF, TXT, DOCX, etc.). Provide either 'url' or 'urls', not both. + A single public URL to a hosted document. Supported types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Provide either 'url' or 'urls', not both. urls : typing.Optional[typing.Sequence[str]] An array of public URLs to hosted documents. Provide either 'url' or 'urls', not both. diff --git a/src/runcaptain/indexing/raw_client.py b/src/runcaptain/indexing/raw_client.py index 9af4bd5..58745db 100644 --- a/src/runcaptain/indexing/raw_client.py +++ b/src/runcaptain/indexing/raw_client.py @@ -1066,7 +1066,7 @@ def index_url_v2( - `url` — a single URL string for one document - `urls` — an array of URL strings for multiple documents - Supported file types include PDF, TXT, DOCX, CSV, XLSX, and more. Documents are downloaded and processed through the same pipeline as cloud storage indexing. + Supported file types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Documents are downloaded and processed through the same pipeline as cloud storage indexing. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}. @@ -1078,7 +1078,7 @@ def index_url_v2( Document processing type. 'advanced' uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. 'basic' provides reliable OCR optimized for general document indexing and high-volume processing. url : typing.Optional[str] - A single public URL to a hosted document (PDF, TXT, DOCX, etc.). Provide either 'url' or 'urls', not both. + A single public URL to a hosted document. Supported types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Provide either 'url' or 'urls', not both. urls : typing.Optional[typing.Sequence[str]] An array of public URLs to hosted documents. Provide either 'url' or 'urls', not both. @@ -2160,7 +2160,7 @@ async def index_url_v2( - `url` — a single URL string for one document - `urls` — an array of URL strings for multiple documents - Supported file types include PDF, TXT, DOCX, CSV, XLSX, and more. Documents are downloaded and processed through the same pipeline as cloud storage indexing. + Supported file types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Documents are downloaded and processed through the same pipeline as cloud storage indexing. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}. @@ -2172,7 +2172,7 @@ async def index_url_v2( Document processing type. 'advanced' uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. 'basic' provides reliable OCR optimized for general document indexing and high-volume processing. url : typing.Optional[str] - A single public URL to a hosted document (PDF, TXT, DOCX, etc.). Provide either 'url' or 'urls', not both. + A single public URL to a hosted document. Supported types: PDF, DOCX, DOC, XLSX, XLS, CSV, TSV, TXT, MD, JSON, YAML, YML, PNG, JPG, JPEG, GIF, BMP, TIFF. Provide either 'url' or 'urls', not both. urls : typing.Optional[typing.Sequence[str]] An array of public URLs to hosted documents. Provide either 'url' or 'urls', not both.