cocoindex 0.1.68__tar.gz → 0.1.70__tar.gz

{cocoindex-0.1.68 → cocoindex-0.1.70}/Cargo.lock

@@ -1297,7 +1297,7 @@ dependencies = [
 
 [[package]]
 name = "cocoindex"
-version = "0.1.68"
+version = "0.1.70"
 dependencies = [
  "anyhow",
  "async-openai",
@@ -1369,6 +1369,7 @@ dependencies = [
  "tree-sitter-java",
  "tree-sitter-javascript",
  "tree-sitter-json",
+ "tree-sitter-kotlin-ng",
  "tree-sitter-language",
  "tree-sitter-md",
  "tree-sitter-pascal",
@@ -5724,6 +5725,16 @@ dependencies = [
  "tree-sitter-language",
 ]
 
+[[package]]
+name = "tree-sitter-kotlin-ng"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e800ebbda938acfbf224f4d2c34947a31994b1295ee6e819b65226c7b51b4450"
+dependencies = [
+ "cc",
+ "tree-sitter-language",
+]
+
 [[package]]
 name = "tree-sitter-language"
 version = "0.1.5"

{cocoindex-0.1.68 → cocoindex-0.1.70}/Cargo.toml

@@ -2,7 +2,7 @@
 name = "cocoindex"
 # Version used for local development is always higher than others to take precedence.
 # Will be overridden for specific release versions.
-version = "0.1.68"
+version = "0.1.70"
 edition = "2024"
 rust-version = "1.88"
 
@@ -63,6 +63,7 @@ reqwest = { version = "0.12.15", default-features = false, features = [
     "rustls-tls",
 ] }
 async-openai = "0.28.0"
+
 tree-sitter = "0.25.3"
 tree-sitter-language = "0.1.5"
 # Per language tree-sitter parsers
@@ -76,6 +77,8 @@ tree-sitter-html = "0.23.2"
 tree-sitter-java = "0.23.5"
 tree-sitter-javascript = "0.23.1"
 tree-sitter-json = "0.24.8"
+# The other more popular crate tree-sitter-kotlin requires tree-sitter < 0.23 for now
+tree-sitter-kotlin-ng = "1.1.0"
 tree-sitter-md = "0.3.2"
 tree-sitter-pascal = "0.10.0"
 tree-sitter-php = "0.23.11"

{cocoindex-0.1.68 → cocoindex-0.1.70}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cocoindex
-Version: 0.1.68
+Version: 0.1.70
 Requires-Dist: click>=8.1.8
 Requires-Dist: rich>=14.0.0
 Requires-Dist: python-dotenv>=1.1.0

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/about/community.md

@@ -9,7 +9,7 @@ Welcome with a huge coconut hug 🥥⋆｡˚🤗.
 
 We are super excited for community contributions of all kinds - whether it's code improvements, documentation updates, issue reports, feature requests on [GitHub](https://github.com/cocoindex-io/cocoindex), and discussions in our [Discord](https://discord.com/invite/zpA9S2DR7s).
 
-We would love to fostering an inclusive, welcoming, and supportive environment. Contributing to CocoIndex should feel collaborative, friendly and enjoyable for everyone. Together, we can build better AI applications through robust data infrastructure.
+We would love to foster an inclusive, welcoming, and supportive environment. Contributing to CocoIndex should feel collaborative, friendly and enjoyable for everyone. Together, we can build better AI applications through robust data infrastructure.
 
 :::tip Start hacking CocoIndex
 Check out our [Contributing guide](./contributing) to get started!

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/about/contributing.md

@@ -18,10 +18,10 @@ We tag issues with the ["good first issue"](https://github.com/cocoindex-io/coco
 ## How to Contribute
 - If you decide to work on an issue, unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`**  or **`Can I work on this issue?`** to avoid duplicating work.
 - For larger features, we recommend you to discuss with us first in our [Discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work.
-- Our [Discord server](https://discord.com/invite/zpA9S2DR7s) are constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
+- Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
 
 ## Start hacking! Setting Up Development Environment
-Following the steps below to get cocoindex build on latest codebase locally - if you are making changes to cocoindex funcionality and want to test it out.
+Follow the steps below to get cocoindex built on the latest codebase locally - if you are making changes to cocoindex functionality and want to test it out.
 
 -   🦀 [Install Rust](https://rust-lang.org/tools/install)
 

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/core/flow_def.mdx

@@ -416,22 +416,28 @@ flow_builder.declare(
 ### Auth Registry
 
 CocoIndex manages an auth registry. It's an in-memory key-value store, mainly to store authentication information for a backend.
+It's usually used for targets, where key stability is important for backend cleanup.
 
-Operation spec is the default way to configure a persistent backend. But it has the following limitations:
+Operation spec is the default way to configure sources, functions and targets. But it has the following limitations:
 
 *   The spec isn't supposed to contain secret information, and it's frequently shown in various places, e.g. `cocoindex show`.
-*   Once an operation is removed after flow definition code change, the spec is also gone.
-    But we still need to be able to drop the backend (e.g. a table) when [setup / drop flow](/docs/core/flow_methods#setup--drop-flow).
+*   For targets, once an operation is removed after flow definition code change, the spec is also gone.
+    But we still need to be able to drop the persistent backend (e.g. a table) when [setup / drop flow](/docs/core/flow_methods#setup--drop-flow).
 
-Auth registry is introduced to solve the problems above. It works as follows:
+Auth registry is introduced to solve the problems above.
 
-*   You can create new **auth entry** by a key and a value.
-*   You can references the entry by the key, and pass it as part of spec for certain operations. e.g. `Neo4j` takes `connection` field in the form of auth entry reference.
+
+#### Auth Entry
+
+An auth entry is an entry in the auth registry with an explicit key.
+
+*   You can create new *auth entry* by a key and a value.
+*   You can reference the entry by the key, and pass it as part of spec for certain operations. e.g. `Neo4j` takes `connection` field in the form of auth entry reference.
 
 <Tabs>
 <TabItem value="python" label="Python" default>
 
-You can add an auth entry by `cocoindex.add_auth_entry()` function, which returns a `cocoindex.AuthEntryReference`:
+You can add an auth entry by `cocoindex.add_auth_entry()` function, which returns a `cocoindex.AuthEntryReference[T]`:
 
 ```python
 my_graph_conn = cocoindex.add_auth_entry(
@@ -445,7 +451,7 @@ my_graph_conn = cocoindex.add_auth_entry(
 
 Then reference it when building a spec that takes an auth entry:
 
-*   You can either reference by the `AuthEntryReference` object directly:
+*   You can either reference by the `AuthEntryReference[T]` object directly:
 
     ```python
     demo_collector.export(
@@ -468,7 +474,32 @@ Then reference it when building a spec that takes an auth entry:
 Note that CocoIndex backends use the key of an auth entry to identify the backend.
 
 *   Keep the key stable.
-    If the key doesn't change, it's considered to be the same backend (even if the underlying way to connect/authenticate change).
+    If the key doesn't change, it's considered to be the same backend (even if the underlying way to connect/authenticate changes).
 
 *   If a key is no longer referenced in any operation spec, keep it until the next flow setup / drop action,
-    so that cocoindex will be able to clean up the backends.
+    so that CocoIndex will be able to clean up the backends.
+
+#### Transient Auth Entry
+
+A transient auth entry is an entry in the auth registry with an automatically generated key.
+It's usually used for sources and functions, where key stability is not important.
+
+<Tabs>
+<TabItem value="python" label="Python" default>
+
+You can create a new *transient auth entry* by `cocoindex.add_transient_auth_entry()` function, which returns a `cocoindex.TransientAuthEntryReference[T]`, and pass it to a source or function spec that takes it, e.g.
+
+```python
+flow_builder.add_source(
+    cocoindex.sources.AzureBlob(
+        ...
+        sas_token=cocoindex.add_transient_auth_entry("...")
+    )
+)
+```
+
+
+</TabItem>
+</Tabs>
+
+Whenever a `TransientAuthEntryReference[T]` is expected, you can also pass a `AuthEntryReference[T]` instead, as `AuthEntryReference[T]` is a subtype of `TransientAuthEntryReference[T]`.

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/core/flow_methods.mdx

@@ -44,9 +44,9 @@ For a flow, its persistent backends need to be ready before it can run, includin
 The desired state of the backends for a flow is derived based on the flow definition itself.
 CocoIndex supports two types of actions to manage the persistent backends automatically:
 
-*   *Setup* a flow, which will change the backends owned by the flow to a state to the desired state, e.g. create new tables for new flow, drop an existing table if the corresponding target is gone, add new column to a target table if a new field is collected, etc. It's no-op if the backend states are already in the desired state.
+*   *Setup* a flow, which will change the backends owned by the flow to the desired state, e.g. create new tables for new flow, drop an existing table if the corresponding target is gone, add new column to a target table if a new field is collected, etc. It's no-op if the backend states are already in the desired state.
 
-*   *Drop* a flow, which will drop all backends owned by the flow. It's no-op if there's no existing backends owned by the flow (e.g. never setup or already dropped).
+*   *Drop* a flow, which will drop all backends owned by the flow. It's no-op if there are no existing backends owned by the flow (e.g. never setup or already dropped).
 
 ### CLI
 
@@ -138,7 +138,7 @@ This is to achieve best efficiency.
 
 The `cocoindex update` subcommand creates/updates data in the target.
 
-Once it's done, the target data is fresh up to the moment when the function is called.
+Once it's done, the target data is fresh up to the moment when the command is called.
 
 ```sh
 cocoindex update main.py
@@ -203,7 +203,7 @@ To perform live update, run the `cocoindex update` subcommand with `-L` option:
 cocoindex update main.py -L
 ```
 
-If there's at least one data source with change capture mechanism enabled, it will keep running until the aborted (e.g. by `Ctrl-C`).
+If there's at least one data source with change capture mechanism enabled, it will keep running until aborted (e.g. by `Ctrl-C`).
 Otherwise, it falls back to the same behavior as one time update, and will finish after a one-time update is done.
 
 With a `--setup` option, it will also setup the flow first if needed.

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/getting_started/quickstart.md

@@ -7,10 +7,10 @@ import ReactPlayer from 'react-player'
 
 # Build your first CocoIndex project
 
-This guide will help you get up and running with CocoIndex in just a few minutes, that does:
+This guide will help you get up and running with CocoIndex in just a few minutes. We'll build a project that does:
 *   Read files from a directory
 *   Perform basic chunking and embedding
-*   loads the data into a vector store (PG Vector)
+*   Load the data into a vector store (PG Vector)
 
 <ReactPlayer controls url='https://www.youtube.com/watch?v=gv5R8nOXsWU' />
 
@@ -107,11 +107,11 @@ Notes:
 3.  A *data source* extracts data from an external source.
     In this example, the `LocalFile` data source imports local files as a KTable (table with a key field, see [KTable](../core/data_types#ktable) for details), each row has `"filename"` and `"content"` fields.
 
-4. After defining the KTable, we extended a new field `"chunks"` to each row by *transforming* the `"content"` field using `SplitRecursively`. The output of the `SplitRecursively` is also a KTable representing each chunk of the document, with `"location"` and `"text"` fields.
+4. After defining the KTable, we extend a new field `"chunks"` to each row by *transforming* the `"content"` field using `SplitRecursively`. The output of the `SplitRecursively` is also a KTable representing each chunk of the document, with `"location"` and `"text"` fields.
 
-5. After defining the KTable, we extended a new field `"embedding"` to each row by *transforming* the `"text"` field using `SentenceTransformerEmbed`.
+5. After defining the KTable, we extend a new field `"embedding"` to each row by *transforming* the `"text"` field using `SentenceTransformerEmbed`.
 
-6. In CocoIndex, a *collector* collects multiple entries of data together. In this example, the `doc_embeddings` collector collects data from all `chunk`s across all `doc`s, and using the collected data to build a vector index `"doc_embeddings"`, using `Postgres`.
+6. In CocoIndex, a *collector* collects multiple entries of data together. In this example, the `doc_embeddings` collector collects data from all `chunk`s across all `doc`s, and uses the collected data to build a vector index `"doc_embeddings"`, using `Postgres`.
 
 ## Step 3: Run the indexing pipeline and queries
 
@@ -271,7 +271,7 @@ Now we can run the same Python file, which will run the new added main logic:
 python quickstart.py
 ```
 
-It will ask you to enter a query and it will return the top 10 results.
+It will ask you to enter a query and it will return the top 5 results.
 
 ## Next Steps
 

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/ops/functions.md

@@ -31,7 +31,7 @@ The spec takes the following fields:
 
     *   `separators_regex` (`list[str]`): A list of regex patterns to split the text.
         Higher-level boundaries should come first, and lower-level should be listed later. e.g. `[r"\n# ", r"\n## ", r"\n\n", r"\. "]`.
-        See [regex Syntax](https://docs.rs/regex/latest/regex/#syntax) for supported regular expression syntax.
+        See [regex syntax](https://docs.rs/regex/latest/regex/#syntax) for supported regular expression syntax.
 
 Input data:
 
@@ -57,9 +57,12 @@ Input data:
 
     We use the `language` field to determine how to split the input text, following these rules:
 
-    *   We'll match the input `language` field against the `language_name` or `aliases` of each element of `custom_languages`, and use the matched one. If value of `language` is null, it'll be treated as empty string when matching `language_name` or `aliases`.
-    *   If no match is found, we'll match the `language` field against the builtin language configurations.
-        For all supported builtin language names and aliases (extensions), see [the code](https://github.com/search?q=org%3Acocoindex-io+lang%3Arust++%22static+TREE_SITTER_LANGUAGE_BY_LANG%22&type=code).
+    *   We match the input `language` field against the following registries in the following order:
+        *   `custom_languages` in the spec, against the `language_name` or `aliases` field of each entry.
+        *   Builtin languages (see [Supported Languages](#supported-languages) section below), against the language, aliases or file extensions of each entry.
+
+        All matches are in a case-insensitive manner. If the value of `language` is null, it'll be treated as empty string.
+
     *   If no match is found, the input will be treated as plain text.
 
     :::
@@ -73,6 +76,42 @@ Return: [*KTable*](/docs/core/data_types#ktable), each row represents a chunk, w
     *   `line` (*Int64*): The line number of the position. Starting from 1.
     *   `column` (*Int64*): The column number of the position. Starting from 1.
 
+### Supported Languages
+
+Currently, `SplitRecursively` supports the following languages:
+
+| Language | Aliases | File Extensions |
+|----------|---------|-----------------|
+| C | | `.c` |
+| C++ | CPP | `.cpp`, `.cc`, `.cxx`, `.h`, `.hpp` |
+| C# | CSharp, CS | `.cs` |
+| CSS | | `.css`, `.scss` |
+| DTD | | `.dtd` |
+| Fortran | F, F90, F95, F03 | `.f`, `.f90`, `.f95`, `.f03` |
+| Go | Golang | `.go` |
+| HTML | | `.html`, `.htm` |
+| Java | | `.java` |
+| JavaScript | JS | `.js` |
+| JSON | | `.json` |
+| Kotlin | | `.kt`, `.kts` |
+| Markdown | MD | `.md`, `.mdx` |
+| Pascal | PAS, DPR, Delphi | `.pas`, `.dpr` |
+| PHP | | `.php` |
+| Python | | `.py` |
+| R | | `.r` |
+| Ruby | | `.rb` |
+| Rust | RS | `.rs` |
+| Scala | | `.scala` |
+| SQL | | `.sql` |
+| Swift | | `.swift` |
+| TOML | | `.toml` |
+| TSX | | `.tsx` |
+| TypeScript | TS | `.ts` |
+| XML | | `.xml` |
+| YAML | | `.yaml`, `.yml` |
+
+
+
 ## SentenceTransformerEmbed
 
 `SentenceTransformerEmbed` embeds a text into a vector space using the [SentenceTransformer](https://huggingface.co/sentence-transformers) library.

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/ops/sources.md

@@ -111,10 +111,9 @@ This is how to setup:
 
 *   In the [Amazon S3 Console](https://s3.console.aws.amazon.com/s3/home), open your S3 bucket. Under *Properties* tab, click *Create event notification*.
     *   Fill in an arbitrary event name, e.g. `S3ChangeNotifications`.
-    *   If you want your AmazonS3 data source expose a subset of files sharing a prefix, set the same prefix here. Otherwise, leave it empty.
+    *   If you want your AmazonS3 data source to expose a subset of files sharing a prefix, set the same prefix here. Otherwise, leave it empty.
     *   Select the following event types: *All object create events*, *All object removal events*.
     *   Select *SQS queue* as the destination, and specify the SQS queue you created above.
-and enable *Change Event Notifications* for your bucket, and specify the SQS queue as the destination.
 
 AWS's [Guide of Configuring a Bucket for Notifications](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ways-to-add-notification-config-to-bucket.html#step1-create-sqs-queue-for-notification) provides more details.
 
@@ -141,7 +140,7 @@ The spec takes the following fields:
     :::info
 
     We will delete messages from the queue after they're processed.
-    If there're unrelated messages in the queue (e.g. test messages that SQS will send automatically on queue creation, messages for a different bucket, for non-included files, etc.), we will delete the message upon receiving it, to avoid keeping receiving irrelevant messages again and again after they're redelivered.
+    If there are unrelated messages in the queue (e.g. test messages that SQS will send automatically on queue creation, messages for a different bucket, for non-included files, etc.), we will delete the message upon receiving it, to avoid repeatedly receiving irrelevant messages after they're redelivered.
 
     :::
 
@@ -171,22 +170,33 @@ These are actions you need to take:
 
 #### Authentication
 
-We use Azure’s **Default Credential** system (DefaultAzureCredential) for secure and flexible authentication.
-This allows you to connect to Azure services without putting any secrets in the code or flow spec.
-It automatically chooses the best authentication method based on your environment:
+We support the following authentication methods:
 
-*   On your local machine: uses your Azure CLI login (`az login`) or environment variables.
+*   Shared access signature (SAS) tokens.
+    You can generate it from the Azure Portal in the settings for a specific container.
+    You need to provide at least *List* and *Read* permissions when generating the SAS token.
+    It's a query string in the form of
+    `sp=rl&st=2025-07-20T09:33:00Z&se=2025-07-19T09:48:53Z&sv=2024-11-04&sr=c&sig=i3FDjsadfklj3%23adsfkk`.
 
-    ```sh
-    az login
-    # Optional: Set a default subscription if you have more than one
-    az account set --subscription "<YOUR_SUBSCRIPTION_NAME_OR_ID>"
-    ```
-*   In Azure (VM, App Service, AKS, etc.): uses the resource’s Managed Identity.
-*   In automated environments: supports Service Principals via environment variables
-    *   `AZURE_CLIENT_ID`
-    *   `AZURE_TENANT_ID`
-    *   `AZURE_CLIENT_SECRET`
+*   Storage account access key. You can find it in the Azure Portal in the settings for a specific storage account.
+
+*   Default credential. When none of the above is provided, it will use the default credential.
+
+    This allows you to connect to Azure services without putting any secrets in the code or flow spec.
+    It automatically chooses the best authentication method based on your environment:
+
+    *   On your local machine: uses your Azure CLI login (`az login`) or environment variables.
+
+        ```sh
+        az login
+        # Optional: Set a default subscription if you have more than one
+        az account set --subscription "<YOUR_SUBSCRIPTION_NAME_OR_ID>"
+        ```
+    *   In Azure (VM, App Service, AKS, etc.): uses the resource’s Managed Identity.
+    *   In automated environments: supports Service Principals via environment variables
+        *   `AZURE_CLIENT_ID`
+        *   `AZURE_TENANT_ID`
+        *   `AZURE_CLIENT_SECRET`
 
 You can refer to [this doc](https://learn.microsoft.com/en-us/azure/developer/python/sdk/authentication/overview) for more details.
 
@@ -203,6 +213,8 @@ The spec takes the following fields:
 *   `excluded_patterns` (`list[str]`, optional): a list of glob patterns to exclude files, e.g. `["*.tmp", "**/*.log"]`.
     Any file or directory matching these patterns will be excluded even if they match `included_patterns`.
     If not specified, no files will be excluded.
+*   `sas_token` (`cocoindex.TransientAuthEntryReference[str]`, optional): a SAS token for authentication.
+*   `account_access_key` (`cocoindex.TransientAuthEntryReference[str]`, optional): an account access key for authentication.
 
     :::info
 
@@ -253,12 +265,12 @@ The spec takes the following fields:
     it's typically cheaper than a full refresh by setting the [refresh interval](../core/flow_def#refresh-interval) especially when the folder contains a large number of files.
     So you can usually set it with a smaller value compared to the `refresh_interval`.
 
-    On the other hand, this only detects changes for files still exists.
-    If the file is deleted (or the current account no longer has access to), this change will not be detected by this change stream.
+    On the other hand, this only detects changes for files that still exist.
+    If the file is deleted (or the current account no longer has access to it), this change will not be detected by this change stream.
 
-    So when a `GoogleDrive` source enabled `recent_changes_poll_interval`, it's still recommended to set a `refresh_interval`, with a larger value.
+    So when a `GoogleDrive` source has `recent_changes_poll_interval` enabled, it's still recommended to set a `refresh_interval`, with a larger value.
     So that most changes can be covered by polling recent changes (with low latency, like 10 seconds), and remaining changes (files no longer exist or accessible) will still be covered (with a higher latency, like 5 minutes, and should be larger if you have a huge number of files like 1M).
-    In reality, configure them based on your requirement: how freshness do you need to target index to be?
+    In reality, configure them based on your requirement: how fresh do you need the target index to be?
 
     :::
 

{cocoindex-0.1.68 → cocoindex-0.1.70}/docs/docs/ops/targets.md

@@ -413,7 +413,7 @@ If you don't have a Neo4j database, you can start a Neo4j database using our doc
 docker compose -f <(curl -L https://raw.githubusercontent.com/cocoindex-io/cocoindex/refs/heads/main/dev/neo4j.yaml) up -d
 ```
 
-If will bring up a Neo4j instance, which can be accessed by username `neo4j` and password `cocoindex`.
+This will bring up a Neo4j instance, which can be accessed by username `neo4j` and password `cocoindex`.
 You can access the Neo4j browser at [http://localhost:7474](http://localhost:7474).
 
 :::warning

{cocoindex-0.1.68 → cocoindex-0.1.70}/examples/amazon_s3_embedding/main.py

@@ -102,12 +102,6 @@ def _main() -> None:
 
     amazon_s3_text_embedding_flow.setup()
     with cocoindex.FlowLiveUpdater(amazon_s3_text_embedding_flow) as updater:
-        while True:
-            updates = updater.next_status_updates()
-            print(f"Updates: {updates}")
-            if not updates.active_sources:
-                break
-
         # Run queries in a loop to demonstrate the query capabilities.
         while True:
             query = input("Enter search query (or Enter to quit): ")

{cocoindex-0.1.68 → cocoindex-0.1.70}/python/cocoindex/__init__.py

@@ -6,7 +6,7 @@ from . import functions, sources, targets, cli, utils
 
 from . import targets as storages  # Deprecated: Use targets instead
 
-from .auth_registry import AuthEntryReference, add_auth_entry, ref_auth_entry
+from .auth_registry import AuthEntryReference, add_auth_entry, add_transient_auth_entry
 from .flow import FlowBuilder, DataScope, DataSlice, Flow, transform_flow
 from .flow import flow_def
 from .flow import EvaluateAndDumpOptions, GeneratedField
@@ -42,6 +42,7 @@ __all__ = [
     # Auth registry
     "AuthEntryReference",
     "add_auth_entry",
+    "add_transient_auth_entry",
     "ref_auth_entry",
     # Flow
     "FlowBuilder",

cocoindex-0.1.70/python/cocoindex/auth_registry.py

@@ -0,0 +1,51 @@
+"""
+Auth registry is used to register and reference auth entries.
+"""
+
+from dataclasses import dataclass
+from typing import Generic, TypeVar
+import threading
+
+from . import _engine  # type: ignore
+from .convert import dump_engine_object
+
+T = TypeVar("T")
+
+# Global atomic counter for generating unique auth entry keys
+_counter_lock = threading.Lock()
+_auth_key_counter = 0
+
+
+def _generate_auth_key() -> str:
+    """Generate a unique auth entry key using a global atomic counter."""
+    global _auth_key_counter  # pylint: disable=global-statement
+    with _counter_lock:
+        _auth_key_counter += 1
+        return f"__auth_{_auth_key_counter}"
+
+
+@dataclass
+class TransientAuthEntryReference(Generic[T]):
+    """Reference an auth entry, may or may not have a stable key."""
+
+    key: str
+
+
+class AuthEntryReference(TransientAuthEntryReference[T]):
+    """Reference an auth entry, with a key stable across ."""
+
+
+def add_transient_auth_entry(value: T) -> TransientAuthEntryReference[T]:
+    """Add an auth entry to the registry. Returns its reference."""
+    return add_auth_entry(_generate_auth_key(), value)
+
+
+def add_auth_entry(key: str, value: T) -> AuthEntryReference[T]:
+    """Add an auth entry to the registry. Returns its reference."""
+    _engine.add_auth_entry(key, dump_engine_object(value))
+    return AuthEntryReference(key)
+
+
+def ref_auth_entry(key: str) -> AuthEntryReference[T]:
+    """Reference an auth entry by its key."""
+    return AuthEntryReference(key)

{cocoindex-0.1.68 → cocoindex-0.1.70}/python/cocoindex/sources.py

@@ -1,6 +1,7 @@
 """All builtin sources."""
 
 from . import op
+from .auth_registry import TransientAuthEntryReference
 import datetime
 
 
@@ -48,6 +49,11 @@ class AmazonS3(op.SourceSpec):
 class AzureBlob(op.SourceSpec):
     """
     Import data from an Azure Blob Storage container. Supports optional prefix and file filtering by glob patterns.
+
+    Authentication mechanisms taken in the following order:
+    - SAS token (if provided)
+    - Account access key (if provided)
+    - Default Azure credential
     """
 
     _op_category = op.OpCategory.SOURCE
@@ -58,3 +64,6 @@ class AzureBlob(op.SourceSpec):
     binary: bool = False
     included_patterns: list[str] | None = None
     excluded_patterns: list[str] | None = None
+
+    sas_token: TransientAuthEntryReference[str] | None = None
+    account_access_key: TransientAuthEntryReference[str] | None = None