call-ai 0.0.0-dev-prompts

package/LICENSE.md

@@ -0,0 +1,232 @@
+The contents of this repository are Copyright (c) corresponding authors and
+contributors, licensed under the `Permissive License Stack` meaning either of:
+
+- Apache-2.0 Software License: https://www.apache.org/licenses/LICENSE-2.0
+  ([...4tr2kfsq](https://dweb.link/ipfs/bafkreiankqxazcae4onkp436wag2lj3ccso4nawxqkkfckd6cg4tr2kfsq))
+
+- MIT Software License: https://opensource.org/licenses/MIT
+  ([...vljevcba](https://dweb.link/ipfs/bafkreiepofszg4gfe2gzuhojmksgemsub2h4uy2gewdnr35kswvljevcba))
+
+You may not use the contents of this repository except in compliance
+with one of the listed Licenses. For an extended clarification of the
+intent behind the choice of Licensing please refer to
+https://protocol.ai/blog/announcing-the-permissive-license-stack/
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the terms listed in this notice is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied. See each License for the specific language
+governing permissions and limitations under that License.
+
+<!--- SPDX-License-Identifier: Apache-2.0 OR MIT -->
+
+`SPDX-License-Identifier: Apache-2.0 OR MIT`
+
+Verbatim copies of both licenses are included below:
+
+<details><summary>Apache-2.0 Software License</summary>
+
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+```
+
+</details>
+
+<details><summary>MIT Software License</summary>
+
+```
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```
+
+</details>

package/README.md

@@ -0,0 +1,264 @@
+# call-ai
+
+A lightweight library for making AI API calls with streaming support.
+
+## Installation
+
+```bash
+npm install call-ai
+# or
+yarn add call-ai
+# or
+pnpm add call-ai
+```
+
+## Usage
+
+```typescript
+import { callAi } from "call-ai";
+
+// Basic usage with string prompt (non-streaming by default)
+const response = await callAi("Explain quantum computing in simple terms", {
+  apiKey: "your-api-key",
+  model: "gpt-4",
+});
+
+// The response is the complete text
+console.log(response);
+
+// With streaming enabled (returns an AsyncGenerator)
+const generator = callAi("Tell me a story", {
+  apiKey: "your-api-key",
+  model: "gpt-4",
+  stream: true,
+});
+
+// Process streaming updates
+for await (const chunk of generator) {
+  console.log(chunk); // Streaming updates as they arrive
+}
+
+// Using message array for more control
+const messages = [
+  { role: "system", content: "You are a helpful assistant." },
+  { role: "user", content: "Explain quantum computing in simple terms" },
+];
+
+const response = await callAi(messages, {
+  apiKey: "your-api-key",
+  model: "gpt-4",
+});
+
+console.log(response);
+
+// Using schema for structured output
+const schema = {
+  name: "exercise_summary",
+  properties: {
+    title: { type: "string" },
+    summary: { type: "string" },
+    points: { type: "array", items: { type: "string" } },
+  },
+  required: ["title", "summary"],
+};
+
+const response = await callAi("Summarize the benefits of exercise", {
+  apiKey: "your-api-key",
+  schema: schema,
+});
+
+const structuredOutput = JSON.parse(response);
+console.log(structuredOutput.title);
+
+// Streaming with schema for OpenRouter structured JSON output
+const schema = {
+  properties: {
+    title: { type: "string" },
+    items: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          name: { type: "string" },
+          description: { type: "string" },
+        },
+      },
+    },
+  },
+};
+
+const generator = callAi("Create a list of sci-fi books", {
+  apiKey: "your-api-key",
+  stream: true,
+  schema: schema,
+});
+
+for await (const chunk of generator) {
+  console.log(chunk); // Shows the partial JSON as it's being generated
+}
+```
+
+## Features
+
+- 🔄 Streaming responses via AsyncGenerator when `stream: true`
+- 🧩 Structured JSON outputs with schema validation
+- 🔌 Full compatibility with OpenRouter's JSON schema format for structured outputs
+- 📝 Support for message arrays with system, user, and assistant roles
+- 🔧 TypeScript support with full type definitions
+- ✅ Works in Node.js and browser environments
+
+## Supported LLM Providers
+
+Call-AI supports all models available through OpenRouter, including:
+
+- OpenAI models (GPT-4, GPT-3.5, etc.)
+- Anthropic Claude
+- Gemini
+- Llama 3
+- Mistral
+- And many more
+
+## Choosing a model
+
+Different LLMs have different strengths when working with structured data. Based on our testing, here's a guide to help you choose the right model for your schema needs:
+
+### Schema Complexity Guide
+
+| Model Family | Grade | Simple Flat Schema | Complex Flat Schema              | Nested Schema | Best For                                                  |
+| ------------ | ----- | ------------------ | -------------------------------- | ------------- | --------------------------------------------------------- |
+| OpenAI       | A     | ✅ Excellent       | ✅ Excellent                     | ✅ Excellent  | Most reliable for all schema types                        |
+| Gemini       | A     | ✅ Excellent       | ✅ Excellent                     | ✅ Good       | Good all-around performance, especially with flat schemas |
+| Claude       | B     | ✅ Excellent       | ⚠️ Good (occasional JSON errors) | ✅ Good       | Simple schemas, robust handling of complex prompts        |
+| Llama 3      | C     | ✅ Good            | ✅ Good                          | ❌ Poor       | Simpler flat schemas, may struggle with nested structures |
+| Deepseek     | C     | ✅ Good            | ✅ Good                          | ❌ Poor       | Basic flat schemas only                                   |
+
+### Schema Structure Recommendations
+
+1. **Flat schemas perform better across all models**. If you need maximum compatibility, avoid deeply nested structures.
+
+2. **Field names matter**. Some models have preferences for certain property naming patterns:
+   - Use simple, common naming patterns like `name`, `type`, `items`, `price`
+   - Avoid deeply nested object hierarchies (more than 2 levels deep)
+   - Keep array items simple (strings or flat objects)
+
+3. **Model-specific considerations**:
+   - **OpenAI models**: Best overall schema adherence and handle complex nesting well
+   - **Claude models**: Great for simple schemas, occasional JSON formatting issues with complex structures
+   - **Gemini models**: Good general performance, handles array properties well
+   - **Llama/Mistral/Deepseek**: Strong with flat schemas, but often ignore nesting structure and provide their own organization
+
+4. **For mission-critical applications** requiring schema adherence, use OpenAI models or implement fallback mechanisms.
+
+## Setting API Keys
+
+You can provide your API key in three ways:
+
+1. Directly in the options:
+
+```typescript
+const response = await callAi("Hello", { apiKey: "your-api-key" });
+```
+
+2. Set globally in the browser:
+
+```typescript
+window.CALLAI_API_KEY = "your-api-key";
+const response = await callAi("Hello");
+```
+
+3. Use environment variables in Node.js (with a custom implementation):
+
+```typescript
+// Example of environment variable integration
+import { callAi } from "call-ai";
+const apiKey = process.env.OPENAI_API_KEY || process.env.OPENROUTER_API_KEY;
+const response = await callAi("Hello", { apiKey });
+```
+
+## API
+
+```typescript
+// Main function
+function callAi(prompt: string | Message[], options?: CallAIOptions): Promise<string> | AsyncGenerator<string, string, unknown>;
+
+// Types
+type Message = {
+  role: "user" | "system" | "assistant";
+  content: string;
+};
+
+interface Schema {
+  /**
+   * Optional schema name that will be sent to the model provider if supported
+   */
+  name?: string;
+  properties: Record<string, any>;
+  required?: string[];
+  additionalProperties?: boolean;
+}
+
+interface CallAIOptions {
+  apiKey?: string;
+  model?: string;
+  endpoint?: string;
+  stream?: boolean;
+  schema?: Schema | null;
+  [key: string]: any;
+}
+```
+
+### Options
+
+- `apiKey`: Your API key (can also be set via window.CALLAI_API_KEY)
+- `model`: Model identifier (default: 'openrouter/auto')
+- `endpoint`: API endpoint (default: 'https://openrouter.ai/api/v1/chat/completions')
+- `stream`: Enable streaming responses (default: false)
+- `schema`: Optional JSON schema for structured output
+- Any other options are passed directly to the API (temperature, max_tokens, etc.)
+
+## License
+
+MIT or Apache-2.0, at your option
+
+## Contributing and Release Process
+
+### Development
+
+1. Fork the repository
+2. Make your changes
+3. Add tests for new functionality
+4. Run tests: `npm test`
+5. Run type checking: `npm run typecheck`
+6. Create a pull request
+
+### Integration Tests
+
+The project includes integration tests that make real API calls to verify functionality with actual LLM models:
+
+1. Copy `.env.example` to `.env` and add your OpenRouter API key
+2. Run integration tests: `npm run test:integration`
+
+Note: Integration tests are excluded from the normal test suite to avoid making API calls during CI/CD. They require a valid API key to execute and will be skipped if no key is provided.
+
+### Release Process
+
+This library uses GitHub Actions to automate the release process:
+
+1. Update the version in `package.json` (follow semver)
+2. Update `CHANGELOG.md` with details of changes
+3. Commit changes: `git commit -am "Release vX.Y.Z"`
+4. Create a git tag: `git tag -a vX.Y.Z -m "Version X.Y.Z"`
+5. Push changes and tag: `git push origin main vX.Y.Z`
+
+The GitHub workflow in `.github/workflows/publish.yml` will:
+
+- Automatically trigger when a new tag is pushed
+- Run tests and type checking
+- Verify the tag signature
+- Publish the package to npm
+
+When making significant changes, remember to:
+
+- Document breaking changes in the changelog
+- Update documentation to reflect API changes
+- Update TypeScript types

package/api-core.d.ts

@@ -0,0 +1,13 @@
+import { CallAIOptions, Message, StreamResponse, ThenableStreamResponse } from "./types.js";
+import { PACKAGE_VERSION } from "./version.js";
+declare function callAi(prompt: string | Message[], options?: CallAIOptions): Promise<string> | ThenableStreamResponse;
+declare function bufferStreamingResults(generator: AsyncGenerator<string, string, unknown>): Promise<string>;
+declare function createBackwardCompatStreamingProxy(promise: Promise<StreamResponse>): ThenableStreamResponse;
+declare function prepareRequestParams(prompt: string | Message[], options?: CallAIOptions): {
+    messages: Message[] | {
+        role: string;
+        content: string;
+    }[];
+    apiKey: string;
+};
+export { callAi, bufferStreamingResults, createBackwardCompatStreamingProxy, prepareRequestParams, PACKAGE_VERSION };