csvai 0.1.0__py3-none-any.whl

csvai-0.1.0.dist-info/METADATA

@@ -0,0 +1,751 @@
+Metadata-Version: 2.4
+Name: csvai
+Version: 0.1.0
+Summary: Enrich CSV or Excel rows using OpenAI models.
+Author: Zyxware Technologies, Vimal Joseph
+License:                     GNU GENERAL PUBLIC LICENSE
+                               Version 2, June 1991
+        
+         Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+         51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+         Everyone is permitted to copy and distribute verbatim copies
+         of this license document, but changing it is not allowed.
+        
+                                    Preamble
+        
+          The licenses for most software are designed to take away your
+        freedom to share and change it.  By contrast, the GNU General Public
+        License is intended to guarantee your freedom to share and change free
+        software--to make sure the software is free for all its users.  This
+        General Public License applies to most of the Free Software
+        Foundation's software and to any other program whose authors commit to
+        using it.  (Some other Free Software Foundation software is covered by
+        the GNU Lesser General Public License instead.)  You can apply it to
+        your programs, too.
+        
+          When we speak of free software, we are referring to freedom, not
+        price.  Our General Public Licenses are designed to make sure that you
+        have the freedom to distribute copies of free software (and charge for
+        this service if you wish), that you receive source code or can get it
+        if you want it, that you can change the software or use pieces of it
+        in new free programs; and that you know you can do these things.
+        
+          To protect your rights, we need to make restrictions that forbid
+        anyone to deny you these rights or to ask you to surrender the rights.
+        These restrictions translate to certain responsibilities for you if you
+        distribute copies of the software, or if you modify it.
+        
+          For example, if you distribute copies of such a program, whether
+        gratis or for a fee, you must give the recipients all the rights that
+        you have.  You must make sure that they, too, receive or can get the
+        source code.  And you must show them these terms so they know their
+        rights.
+        
+          We protect your rights with two steps: (1) copyright the software, and
+        (2) offer you this license which gives you legal permission to copy,
+        distribute and/or modify the software.
+        
+          Also, for each author's protection and ours, we want to make certain
+        that everyone understands that there is no warranty for this free
+        software.  If the software is modified by someone else and passed on, we
+        want its recipients to know that what they have is not the original, so
+        that any problems introduced by others will not reflect on the original
+        authors' reputations.
+        
+          Finally, any free program is threatened constantly by software
+        patents.  We wish to avoid the danger that redistributors of a free
+        program will individually obtain patent licenses, in effect making the
+        program proprietary.  To prevent this, we have made it clear that any
+        patent must be licensed for everyone's free use or not licensed at all.
+        
+          The precise terms and conditions for copying, distribution and
+        modification follow.
+        
+                            GNU GENERAL PUBLIC LICENSE
+           TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+        
+          0. This License applies to any program or other work which contains
+        a notice placed by the copyright holder saying it may be distributed
+        under the terms of this General Public License.  The "Program", below,
+        refers to any such program or work, and a "work based on the Program"
+        means either the Program or any derivative work under copyright law:
+        that is to say, a work containing the Program or a portion of it,
+        either verbatim or with modifications and/or translated into another
+        language.  (Hereinafter, translation is included without limitation in
+        the term "modification".)  Each licensee is addressed as "you".
+        
+        Activities other than copying, distribution and modification are not
+        covered by this License; they are outside its scope.  The act of
+        running the Program is not restricted, and the output from the Program
+        is covered only if its contents constitute a work based on the
+        Program (independent of having been made by running the Program).
+        Whether that is true depends on what the Program does.
+        
+          1. You may copy and distribute verbatim copies of the Program's
+        source code as you receive it, in any medium, provided that you
+        conspicuously and appropriately publish on each copy an appropriate
+        copyright notice and disclaimer of warranty; keep intact all the
+        notices that refer to this License and to the absence of any warranty;
+        and give any other recipients of the Program a copy of this License
+        along with the Program.
+        
+        You may charge a fee for the physical act of transferring a copy, and
+        you may at your option offer warranty protection in exchange for a fee.
+        
+          2. You may modify your copy or copies of the Program or any portion
+        of it, thus forming a work based on the Program, and copy and
+        distribute such modifications or work under the terms of Section 1
+        above, provided that you also meet all of these conditions:
+        
+            a) You must cause the modified files to carry prominent notices
+            stating that you changed the files and the date of any change.
+        
+            b) You must cause any work that you distribute or publish, that in
+            whole or in part contains or is derived from the Program or any
+            part thereof, to be licensed as a whole at no charge to all third
+            parties under the terms of this License.
+        
+            c) If the modified program normally reads commands interactively
+            when run, you must cause it, when started running for such
+            interactive use in the most ordinary way, to print or display an
+            announcement including an appropriate copyright notice and a
+            notice that there is no warranty (or else, saying that you provide
+            a warranty) and that users may redistribute the program under
+            these conditions, and telling the user how to view a copy of this
+            License.  (Exception: if the Program itself is interactive but
+            does not normally print such an announcement, your work based on
+            the Program is not required to print an announcement.)
+        
+        These requirements apply to the modified work as a whole.  If
+        identifiable sections of that work are not derived from the Program,
+        and can be reasonably considered independent and separate works in
+        themselves, then this License, and its terms, do not apply to those
+        sections when you distribute them as separate works.  But when you
+        distribute the same sections as part of a whole which is a work based
+        on the Program, the distribution of the whole must be on the terms of
+        this License, whose permissions for other licensees extend to the
+        entire whole, and thus to each and every part regardless of who wrote it.
+        
+        Thus, it is not the intent of this section to claim rights or contest
+        your rights to work written entirely by you; rather, the intent is to
+        exercise the right to control the distribution of derivative or
+        collective works based on the Program.
+        
+        In addition, mere aggregation of another work not based on the Program
+        with the Program (or with a work based on the Program) on a volume of
+        a storage or distribution medium does not bring the other work under
+        the scope of this License.
+        
+          3. You may copy and distribute the Program (or a work based on it,
+        under Section 2) in object code or executable form under the terms of
+        Sections 1 and 2 above provided that you also do one of the following:
+        
+            a) Accompany it with the complete corresponding machine-readable
+            source code, which must be distributed under the terms of Sections
+            1 and 2 above on a medium customarily used for software interchange; or,
+        
+            b) Accompany it with a written offer, valid for at least three
+            years, to give any third party, for a charge no more than your
+            cost of physically performing source distribution, a complete
+            machine-readable copy of the corresponding source code, to be
+            distributed under the terms of Sections 1 and 2 above on a medium
+            customarily used for software interchange; or,
+        
+            c) Accompany it with the information you received as to the offer
+            to distribute corresponding source code.  (This alternative is
+            allowed only for noncommercial distribution and only if you
+            received the program in object code or executable form with such
+            an offer, in accord with Subsection b above.)
+        
+        The source code for a work means the preferred form of the work for
+        making modifications to it.  For an executable work, complete source
+        code means all the source code for all modules it contains, plus any
+        associated interface definition files, plus the scripts used to
+        control compilation and installation of the executable.  However, as a
+        special exception, the source code distributed need not include
+        anything that is normally distributed (in either source or binary
+        form) with the major components (compiler, kernel, and so on) of the
+        operating system on which the executable runs, unless that component
+        itself accompanies the executable.
+        
+        If distribution of executable or object code is made by offering
+        access to copy from a designated place, then offering equivalent
+        access to copy the source code from the same place counts as
+        distribution of the source code, even though third parties are not
+        compelled to copy the source along with the object code.
+        
+          4. You may not copy, modify, sublicense, or distribute the Program
+        except as expressly provided under this License.  Any attempt
+        otherwise to copy, modify, sublicense or distribute the Program is
+        void, and will automatically terminate your rights under this License.
+        However, parties who have received copies, or rights, from you under
+        this License will not have their licenses terminated so long as such
+        parties remain in full compliance.
+        
+          5. You are not required to accept this License, since you have not
+        signed it.  However, nothing else grants you permission to modify or
+        distribute the Program or its derivative works.  These actions are
+        prohibited by law if you do not accept this License.  Therefore, by
+        modifying or distributing the Program (or any work based on the
+        Program), you indicate your acceptance of this License to do so, and
+        all its terms and conditions for copying, distributing or modifying
+        the Program or works based on it.
+        
+          6. Each time you redistribute the Program (or any work based on the
+        Program), the recipient automatically receives a license from the
+        original licensor to copy, distribute or modify the Program subject to
+        these terms and conditions.  You may not impose any further
+        restrictions on the recipients' exercise of the rights granted herein.
+        You are not responsible for enforcing compliance by third parties to
+        this License.
+        
+          7. If, as a consequence of a court judgment or allegation of patent
+        infringement or for any other reason (not limited to patent issues),
+        conditions are imposed on you (whether by court order, agreement or
+        otherwise) that contradict the conditions of this License, they do not
+        excuse you from the conditions of this License.  If you cannot
+        distribute so as to satisfy simultaneously your obligations under this
+        License and any other pertinent obligations, then as a consequence you
+        may not distribute the Program at all.  For example, if a patent
+        license would not permit royalty-free redistribution of the Program by
+        all those who receive copies directly or indirectly through you, then
+        the only way you could satisfy both it and this License would be to
+        refrain entirely from distribution of the Program.
+        
+        If any portion of this section is held invalid or unenforceable under
+        any particular circumstance, the balance of the section is intended to
+        apply and the section as a whole is intended to apply in other
+        circumstances.
+        
+        It is not the purpose of this section to induce you to infringe any
+        patents or other property right claims or to contest validity of any
+        such claims; this section has the sole purpose of protecting the
+        integrity of the free software distribution system, which is
+        implemented by public license practices.  Many people have made
+        generous contributions to the wide range of software distributed
+        through that system in reliance on consistent application of that
+        system; it is up to the author/donor to decide if he or she is willing
+        to distribute software through any other system and a licensee cannot
+        impose that choice.
+        
+        This section is intended to make thoroughly clear what is believed to
+        be a consequence of the rest of this License.
+        
+          8. If the distribution and/or use of the Program is restricted in
+        certain countries either by patents or by copyrighted interfaces, the
+        original copyright holder who places the Program under this License
+        may add an explicit geographical distribution limitation excluding
+        those countries, so that distribution is permitted only in or among
+        countries not thus excluded.  In such case, this License incorporates
+        the limitation as if written in the body of this License.
+        
+          9. The Free Software Foundation may publish revised and/or new versions
+        of the General Public License from time to time.  Such new versions will
+        be similar in spirit to the present version, but may differ in detail to
+        address new problems or concerns.
+        
+        Each version is given a distinguishing version number.  If the Program
+        specifies a version number of this License which applies to it and "any
+        later version", you have the option of following the terms and conditions
+        either of that version or of any later version published by the Free
+        Software Foundation.  If the Program does not specify a version number of
+        this License, you may choose any version ever published by the Free Software
+        Foundation.
+        
+          10. If you wish to incorporate parts of the Program into other free
+        programs whose distribution conditions are different, write to the author
+        to ask for permission.  For software which is copyrighted by the Free
+        Software Foundation, write to the Free Software Foundation; we sometimes
+        make exceptions for this.  Our decision will be guided by the two goals
+        of preserving the free status of all derivatives of our free software and
+        of promoting the sharing and reuse of software generally.
+        
+                                    NO WARRANTY
+        
+          11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+        FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+        OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+        PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+        OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+        TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+        PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+        REPAIR OR CORRECTION.
+        
+          12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+        REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+        INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+        OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+        TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+        YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+        PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGES.
+        
+                             END OF TERMS AND CONDITIONS
+        
+                    How to Apply These Terms to Your New Programs
+        
+          If you develop a new program, and you want it to be of the greatest
+        possible use to the public, the best way to achieve this is to make it
+        free software which everyone can redistribute and change under these terms.
+        
+          To do so, attach the following notices to the program.  It is safest
+        to attach them to the start of each source file to most effectively
+        convey the exclusion of warranty; and each file should have at least
+        the "copyright" line and a pointer to where the full notice is found.
+        
+            <one line to give the program's name and a brief idea of what it does.>
+            Copyright (C) <year>  <name of author>
+        
+            This program is free software; you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation; either version 2 of the License, or
+            (at your option) any later version.
+        
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
+        
+            You should have received a copy of the GNU General Public License along
+            with this program; if not, write to the Free Software Foundation, Inc.,
+            51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+        
+        Also add information on how to contact you by electronic and paper mail.
+        
+        If the program is interactive, make it output a short notice like this
+        when it starts in an interactive mode:
+        
+            Gnomovision version 69, Copyright (C) year name of author
+            Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+            This is free software, and you are welcome to redistribute it
+            under certain conditions; type `show c' for details.
+        
+        The hypothetical commands `show w' and `show c' should show the appropriate
+        parts of the General Public License.  Of course, the commands you use may
+        be called something other than `show w' and `show c'; they could even be
+        mouse-clicks or menu items--whatever suits your program.
+        
+        You should also get your employer (if you work as a programmer) or your
+        school, if any, to sign a "copyright disclaimer" for the program, if
+        necessary.  Here is a sample; alter the names:
+        
+          Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+          `Gnomovision' (which makes passes at compilers) written by James Hacker.
+        
+          <signature of Ty Coon>, 1 April 1989
+          Ty Coon, President of Vice
+        
+        This General Public License does not permit incorporating your program into
+        proprietary programs.  If your program is a subroutine library, you may
+        consider it more useful to permit linking proprietary applications with the
+        library.  If this is what you want to do, use the GNU Lesser General
+        Public License instead of this License.
+        
+Project-URL: Homepage, https://www.zyxware.com/article/6935/csvai-automate-data-enrichment-any-csv-or-excel-file-generative-ai
+Project-URL: Bug Tracker, https://github.com/zyxware/csvai/issues
+Project-URL: Source, https://github.com/zyxware/csvai
+Project-URL: Contact, https://www.zyxware.com/contact-us
+Keywords: csv,excel,ai,openai,data enrichment,llm,automation
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.99.0
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: openpyxl>=3.1.0
+Provides-Extra: ui
+Requires-Dist: streamlit; extra == "ui"
+Dynamic: license-file
+
+# CSVAI — Apply an AI prompt to each row in a CSV or Excel file and write enriched results
+
+The `csvai` library reads an input CSV or Excel file, renders a prompt for each row (you can use raw column names like `{{ Address }}`), calls an **OpenAI model via the Responses API**, and writes the original columns plus AI-generated fields to an output CSV or Excel file.
+
+The tool is **async + concurrent**, **resumable**, and **crash-safe**. It supports **Structured Outputs** with a **JSON Schema** for reliable JSON, or **JSON mode** (without a schema) if you prefer a lighter setup.
+
+We also have a **CSV AI Prompt Builder** (a Custom GPT) to help you generate prompts and JSON Schemas tailored to your CSVs.
+
+---
+
+## Features
+
+* **Structured Outputs**: enforce exact JSON with a schema for consistent, validated results.
+* **JSON mode**: force a single JSON object without defining a schema.
+* **Async & concurrent**: process many rows in parallel for faster throughput.
+* **Resumable**: rows already written (by `id`) are skipped on re-run.
+* **CSV or Excel**: handle `.csv` and `.xlsx` inputs and outputs.
+
+---
+
+## Installation
+
+Requires Python **3.9+**.
+OpenAI API Key: Create a key - https://platform.openai.com/api-keys and use it in the .env file with OPENAI_API_KEY=
+See example.env in the [project repo](https://github.com/zyxware/csvai).
+
+### From PyPI
+
+```bash
+pip install csvai
+# Include Streamlit UI dependencies
+pip install "csvai[ui]"
+```
+
+### From GitHub
+
+```bash
+# Install directly from the repository
+pip install git+https://github.com/zyxware/csvai.git
+# With Streamlit UI dependencies
+pip install "csvai[ui] @ git+https://github.com/zyxware/csvai.git"
+```
+
+### For local development
+
+```bash
+git clone https://github.com/zyxware/csvai
+cd csvai
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+pip install -e .
+cp example.env .env
+# Edit .env and set OPENAI_API_KEY=sk-...
+```
+
+Installing the package exposes the `csvai` CLI and the `csvai-ui` command.
+
+---
+
+## Usage
+
+### CLI
+
+#### Auto-discovery
+
+If you name your files like this:
+
+```
+input.csv      # or input.xlsx
+input.prompt.txt
+input.schema.json   # optional
+```
+
+Run:
+
+```bash
+csvai input.csv      # or input.xlsx
+```
+
+#### Or specify prompt & schema explicitly
+
+```bash
+# With a prompt and a strict schema (best reliability)
+csvai address.xlsx --prompt address.prompt.txt --schema address.schema.json
+
+# Or JSON mode (no schema; still a single JSON object)
+csvai address.xlsx --prompt address.prompt.txt
+```
+
+Sample datasets (`address.csv` and `address.xlsx`) with the matching prompt and schema live in the `example/` directory.
+
+### Streamlit UI
+
+After installing with the `ui` extra, launch the web interface:
+
+```bash
+csvai-ui
+```
+
+The UI lets you upload a CSV/Excel file, provide a prompt and optional schema.
+
+---
+
+## Example Prompt & Schema
+
+### Prompt (`address.prompt.txt`)
+
+```text
+Extract city, state, and country from the given address.
+
+Rules:
+- city: city/town/locality (preserve accents, proper case)
+- state: ISO-standard name of the state/region/province or "" if none
+- country: ISO 3166 English short name of the country; infer if obvious, else ""
+- Ignore descriptors like "(EU)"
+- Do not guess street-level info
+
+Inputs:
+Address: {{Address}}
+```
+
+### Schema (`address.schema.json`)
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "city": {
+      "type": "string",
+      "description": "City, town, or locality name with correct casing and accents preserved"
+    },
+    "state": {
+      "type": "string",
+      "description": "ISO-standard name of the state, region, or province, or empty string if none"
+    },
+    "country": {
+      "type": "string",
+      "description": "ISO 3166 English short name of the country, inferred if obvious, else empty string"
+    }
+  },
+  "required": ["city", "state", "country"],
+  "additionalProperties": false
+}
+```
+---
+
+## Creating Prompts & Schemas with the CSV AI Prompt Builder
+
+You can use the **[CSV AI Prompt Builder](https://chat.openai.com/g/g-689d8067bd888191a896d2cfdab27a39-csv-ai-prompt-builder)** custom GPT to:
+
+* Quickly design a **prompt** tailored to your CSV data.
+* Generate a **JSON Schema** that matches your desired structured output.
+
+**Example input to the builder:**
+
+```
+File: reviews.csv. Inputs: title,body,stars. Output: sentiment,summary.
+```
+
+**Example result:**
+
+**Prompt**
+
+```
+Analyze each review and produce sentiment and a concise summary.
+
+Rules:
+- sentiment: one of positive, neutral, negative.
+- Star mapping: stars ≤ 2 ⇒ negative; 3 ⇒ neutral; ≥ 4 ⇒ positive. If stars is blank or invalid, infer from tone.
+- summary: 1–2 sentences, factual, include key pros/cons, no emojis, no first person, no marketing fluff.
+- Use the same language as the Body.
+- Return only the fields required by the tool schema.
+
+Inputs:
+Title: {{title}}
+Body: {{body}}
+Stars: {{stars}}
+```
+
+**Schema**
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "sentiment": {
+      "type": "string",
+      "description": "Overall sentiment derived from stars and/or tone; one of positive, neutral, negative",
+      "enum": ["positive", "neutral", "negative"]
+    },
+    "summary": {
+      "type": "string",
+      "description": "Concise 1–2 sentence summary capturing key pros/cons without opinionated fluff"
+    }
+  },
+  "required": ["sentiment", "summary"],
+  "additionalProperties": false
+}
+```
+
+**Command to execute**
+
+```bash
+python -m csvai.cli reviews.csv --prompt reviews.prompt.txt --schema reviews.schema.json
+```
+**Tip — have the builder generate a schema for you**
+* **I have `products.csv` with Product Title, Product Description, Category, and Sub Category. Help me enrich with SEO meta fields.**
+* **I have `reviews.csv` with Title, Body, and Stars. Help me extract sentiment and generate a short summary.**
+* **I have `address.csv` with an Address field. Help me extract City, State, and Country using ISO-standard names.**
+* **I have `tickets.csv` with Subject and Description. Help me classify each ticket into predefined support categories.**
+* **I have `posts.csv` with Title, Body, URL, Image URL, Brand, and Platform. Help me generate social media captions, hashtags, emojis, CTAs, and alt text.**
+* **I have `jobs.csv` with Job Title and Description. Help me categorize jobs into sectors and identify the level of seniority.**
+
+
+---
+
+## CLI
+
+```bash
+csvai INPUT.csv [--prompt PROMPT_FILE] [--output OUTPUT_FILE]
+                          [--limit N] [--model MODEL] [--schema SCHEMA_FILE]
+```
+
+**Flags**
+
+* `--prompt, -p` — path to a plaintext prompt file (Jinja template).
+* `--output, -o` — output CSV path (default: `<input>_enriched.csv`).
+* `--limit` — process only the first `N` new/pending rows.
+* `--model` — model name (default from `.env`, falls back to `gpt-4o-mini`).
+* `--schema` — path to a JSON Schema for structured outputs (optional).
+
+---
+
+## Environment Variables (`.env`)
+
+See [`example.env`](example.env) for all configurable variables.
+
+```ini
+OPENAI_API_KEY=sk-...
+DEFAULT_MODEL=gpt-4o-mini
+MAX_OUTPUT_TOKENS=600
+TEMPERATURE=0.2
+MAX_CONCURRENT_REQUESTS=12
+PROCESSING_BATCH_SIZE=100
+REQUEST_TIMEOUT=45
+ALT_PROMPT_SUFFIX=.prompt.txt
+OUTPUT_FILE_SUFFIX=_enriched.csv
+```
+
+---
+
+## Input/Output Behavior
+
+* **Input CSV**: the script reads all rows. If an `id` column exists, it’s used to resume. If not, rows are indexed `0..N-1` internally for this run.
+* **Prompt rendering**: every row is sanitized so `{{ Raw Header }}` becomes `{{ Raw_Header }}`. You can also reference the raw values as `{{ raw["Raw Header"] }}` if needed.
+* **Output CSV**: contains the original columns plus AI-generated fields. The **header is fixed** after the first successful batch; later rows are written with the same header order.
+* **Resume**: rerunning skips rows whose `id` is already present in the output file.
+
+---
+
+## Structured Outputs vs JSON Mode
+
+### Structured Outputs (recommended)
+
+When you pass `--schema`, the request includes:
+
+```python
+text={
+  "format": {
+    "type": "json_schema",
+    "name": "row_schema",
+    "schema": schema,
+    "strict": true
+  }
+}
+```
+
+This guarantees the model returns **exactly** the keys/types you expect.
+
+### JSON Mode (no schema)
+
+When no schema is provided, the request includes:
+
+```python
+text={"format": {"type": "json_object"}}
+```
+
+The model must still return a single JSON object, but no exact schema is enforced.
+
+> **Prompting tip:** mention the word **JSON** in your prompt and explicitly list the expected fields to improve compliance in JSON mode.
+
+---
+
+## Performance & Concurrency
+
+* Concurrency is controlled by `MAX_CONCURRENT_REQUESTS`.
+* Increase gradually; too high can trigger API rate limits.
+* `PROCESSING_BATCH_SIZE` controls how many results are written per batch.
+* `REQUEST_TIMEOUT` guards slow requests; the script retries with backoff.
+
+---
+
+## Troubleshooting
+
+**“Missing required parameter: `text.format.name`”**
+You used structured outputs but didn’t include `name` **alongside** `type` and `schema`. The script already sends this correctly; ensure you’re on the latest version and that `--schema` points to the right file.
+
+**“Invalid schema … `required` must include every key”**
+The Responses structured-outputs path expects `required` to include **all** keys in `properties`. Either (a) add them all to `required`, (b) remove non-required keys from `properties`, or (c) use JSON mode.
+
+**Rows not resuming**
+Ensure there’s an `id` column in both input and output. If not present, the script uses positional IDs for the current run only.
+
+---
+
+## FAQ
+
+**Q: Does it run concurrently?**
+Yes. Concurrency is controlled via `MAX_CONCURRENT_REQUESTS` (default 10).
+
+**Q: Can I rely on an `id` column?**
+Yes. If present in the input CSV, it’s used for resumability. Otherwise rows are indexed for the session.
+
+**Q: Can I output nested JSON?**
+The schema can be nested, but CSV is flat. If you want nested data, extend the script with a flattener (e.g., convert `address.street` → `address_street`).
+
+**Q: Which models work?**
+Recent `gpt-4o*` models support Responses + Structured Outputs. If a model doesn’t support it, use JSON mode.
+
+**Q: Do I need a JSON schema?**
+No, but it’s strongly recommended for stable columns and fewer parse failures.
+
+---
+
+## Support
+
+This application was developed as an internal tool and we will continue to improve and optimize it as long as we use it. If you would like us to customize this or build a similar or related system to automate your tasks with AI, we are available for **commercial support**.
+
+---
+
+### About Zyxware Technologies
+
+At **Zyxware Technologies**, our mission is to help organizations harness the power of technology to solve real-world problems. Guided by our founding values of honesty and fairness, we are committed to delivering genuine value to our clients and the free and open-source community.
+
+**CSVAI** is a direct result of this philosophy. We originally developed it to automate and streamline our own internal data-enrichment tasks. Realizing its potential to help others, we are sharing it as a free tool in the spirit of our commitment to Free Software.
+
+Our expertise is centered around our **AI & Automation Services**. We specialize in building intelligent solutions that reduce manual effort, streamline business operations, and unlock data-driven insights. While we provide powerful free tools like this one, we also offer **custom development and commercial support** for businesses that require tailored AI solutions.
+
+If you're looking to automate a unique business process or build a similar system, we invite you to [**reach out to us**](https://www.zyxware.com/contact-us) to schedule a free discovery call.
+
+---
+
+## Updates
+
+For updates and new versions, visit: [Project Page @ Zyxware](https://www.zyxware.com/article/6935/csvai-automate-data-enrichment-any-csv-or-excel-file-generative-ai)
+
+---
+
+## Contact
+
+[https://www.zyxware.com/contact-us](https://www.zyxware.com/contact-us)
+
+---
+
+## Source Repository
+
+[https://github.com/zyxware/csvai](https://github.com/zyxware/csvai)
+
+---
+
+## Reporting Issues
+
+[https://github.com/zyxware/csvai/issues](https://github.com/zyxware/csvai/issues)
+
+---
+
+## License and Disclaimer
+
+**GPL v2** – Free to use & modify. Use it at your own risk. We are not collecting any user data.
+
+---
+
+## Need Help or Commercial Support?
+
+If you have any questions, feel free to [contact us](https://www.zyxware.com/contact-us).