@falkordb/text-to-cypher 0.1.10 → 0.1.12

package/README.md

@@ -142,40 +142,51 @@ console.log('Relationships:', schemaObj.relationships);
 
 Lists all available AI models across all supported providers.
 
-**Returns:** `Promise<string[]>`
+**Note:** This method queries all provider APIs (OpenAI, Anthropic, Gemini, Ollama) and aggregates the results. Models are returned with provider prefixes (except OpenAI).
+
+**Returns:** `Promise<string[]>` - Array of model names with provider prefixes where applicable
 
 **Example:**
 ```javascript
 const models = await client.listModels();
-console.log('Available models:', models);
-// Output: ['gpt-4o-mini', 'gpt-4o', 'anthropic:claude-3-5-sonnet-20241022', ...]
+console.log('All available models:', models);
+// Output: [
+//   'gpt-4o-mini', 'gpt-4o', 'gpt-4-turbo',  // OpenAI (no prefix)
+//   'anthropic:claude-sonnet-4-5', 'anthropic:claude-opus-4-5',  // Anthropic
+//   'gemini:gemini-2.5-pro', 'gemini:gemini-3-pro-preview',  // Gemini
+//   'ollama:llama3', 'ollama:mistral'  // Ollama (if running)
+// ]
 ```
 
 ### `listModelsByProvider(provider)`
 
-Lists available AI models from a specific provider.
+Lists available AI models from a specific provider by querying the actual provider APIs.
+
+**Note:** This method makes real API calls to the AI providers to get current model listings. The availability depends on your API credentials and the current offerings from each provider.
 
 **Parameters:**
-- `provider` (string): Provider name - `'openai'`, `'anthropic'`, `'gemini'`, or `'ollama'`
+- `provider` (string): Provider name - `'openai'`, `'anthropic'`, `'gemini'`, or `'ollama'` (case-insensitive)
 
-**Returns:** `Promise<string[]>`
+**Returns:** `Promise<string[]>` - Array of model names (without provider prefixes)
 
 **Example:**
 ```javascript
 // List OpenAI models
 const openaiModels = await client.listModelsByProvider('openai');
 console.log('OpenAI models:', openaiModels);
-// Output: ['gpt-4o-mini', 'gpt-4o', 'gpt-4-turbo', 'gpt-4', 'gpt-3.5-turbo']
+// Output: ['gpt-4o-mini', 'gpt-4o', 'gpt-4-turbo', ...]
 
 // List Anthropic models
 const anthropicModels = await client.listModelsByProvider('anthropic');
 console.log('Anthropic models:', anthropicModels);
+// Output: ['claude-sonnet-4-5', 'claude-opus-4-5', 'claude-haiku-4-5']
 
 // List Gemini models
 const geminiModels = await client.listModelsByProvider('gemini');
 console.log('Gemini models:', geminiModels);
+// Output: ['gemini-2.5-pro', 'gemini-3-pro-preview', ...]
 
-// List Ollama models
+// List Ollama models (requires Ollama running locally)
 const ollamaModels = await client.listModelsByProvider('ollama');
 console.log('Ollama models:', ollamaModels);
 ```
@@ -185,11 +196,11 @@ console.log('Ollama models:', ollamaModels);
 - **`openai`** - OpenAI models (GPT-4, GPT-3.5, etc.)
   - Models can be used directly: `'gpt-4o-mini'`
 - **`anthropic`** - Anthropic models (Claude variants)
-  - Models require prefix: `'anthropic:claude-3-5-sonnet-20241022'`
+  - Models require prefix when using: `'anthropic:claude-sonnet-4-5'`
 - **`gemini`** - Google Gemini models
-  - Models require prefix: `'gemini:gemini-2.0-flash-exp'`
+  - Models require prefix when using: `'gemini:gemini-2.5-pro'`
 - **`ollama`** - Local Ollama models (if configured)
-  - Models require prefix: `'ollama:llama3'`
+  - Models require prefix when using: `'ollama:llama3'`
 
 See the [examples/list-models.js](examples/list-models.js) file for a complete working example.
 

package/examples/list-models.js

@@ -1,10 +1,13 @@
 /**
  * Model Discovery Example for @falkordb/text-to-cypher
- * 
+ *
  * This example demonstrates how to:
- * 1. List all available AI models across all providers
+ * 1. List all available models across all providers
  * 2. List models from specific providers (OpenAI, Anthropic, Gemini, Ollama)
  * 3. Handle provider-specific model naming conventions
+ * 4. Use the discovered models in your client configuration
+ *
+ * Note: This queries the actual AI provider APIs for current model listings.
  */
 
 const { TextToCypher } = require('../index');
@@ -25,15 +28,13 @@ async function main() {
 
   try {
     // Example 1: List all available models
-    console.log('1. Listing all available models across all providers...');
+    console.log('1. Listing all available models...');
     const allModels = await client.listModels();
-    console.log('\nAll available models:');
+    console.log(`\nFound ${allModels.length} total models:\n`);
     allModels.forEach((model, index) => {
-      console.log(`  ${index + 1}. ${model}`);
+      console.log(`  ${(index + 1).toString().padStart(2)}. ${model}`);
     });
-    console.log(`\nTotal: ${allModels.length} models\n`);
-
-    console.log('---\n');
+    console.log('\n---\n');
 
     // Example 2: List models by provider
     console.log('2. Listing models by provider...\n');
@@ -82,11 +83,12 @@ async function main() {
 
     // Example 5: Provider-specific naming conventions
     console.log('5. Note on provider-specific naming conventions:');
-    console.log('\nOpenAI models can be used directly:');
+    console.log('\nThe API returns model names without prefixes.');
+    console.log('When using models, OpenAI models can be used directly:');
     console.log('  model: \'gpt-4o-mini\'');
-    console.log('\nOther providers require a prefix:');
-    console.log('  model: \'anthropic:claude-3-5-sonnet-20241022\'');
-    console.log('  model: \'gemini:gemini-2.0-flash-exp\'');
+    console.log('\nOther providers require adding a prefix:');
+    console.log('  model: \'anthropic:claude-sonnet-4-5\'');
+    console.log('  model: \'gemini:gemini-2.5-pro\'');
     console.log('  model: \'ollama:llama3\'\n');
 
   } catch (error) {

package/index.d.ts

@@ -174,23 +174,19 @@ export declare class TextToCypher {
   /**
    * Lists all available AI models across all supported providers
    *
-   * Returns a list of commonly available models from OpenAI, Anthropic, Gemini, and Ollama.
-   *
-   * # Note
-   *
-   * This method returns a curated list of well-known models. The actual availability
-   * of models depends on your API credentials and the current offerings from each provider.
+   * This method queries all provider APIs (OpenAI, Anthropic, Gemini, Ollama) and
+   * returns a combined list of available models with provider prefixes.
    *
    * # Returns
    *
-   * A promise that resolves to an array of model names
+   * A promise that resolves to an array of model names with provider prefixes
    *
    * # Example
    *
    * ```javascript
-   * const models = await client.listModels();
-   * console.log('Available models:', models);
-   * // Output: ['gpt-4o-mini', 'gpt-4o', 'claude-3-5-sonnet-20241022', ...]
+   * const allModels = await client.listModels();
+   * console.log('All models:', allModels);
+   * // Output: ['gpt-4o-mini', 'gpt-4o', 'anthropic:claude-sonnet-4-5', 'gemini:gemini-2.5-pro', ...]
    * ```
    */
   listModels(): Promise<Array<string>>
@@ -203,12 +199,12 @@ export declare class TextToCypher {
    *
    * # Note
    *
-   * This method returns a curated list of well-known models. The actual availability
-   * of models depends on your API credentials and the current offerings from each provider.
+   * This method queries the actual AI provider APIs to get the list of available models.
+   * The availability depends on your API credentials and the current offerings from each provider.
    *
    * # Returns
    *
-   * A promise that resolves to an array of model names for the specified provider
+   * A promise that resolves to an array of model names for the specified provider (without prefixes)
    *
    * # Example
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@falkordb/text-to-cypher",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "Node.js bindings for FalkorDB text-to-cypher library - Convert natural language to Cypher queries",
   "main": "index.js",
   "types": "index.d.ts",