AI::_OPENAI_INDEX 1g 2024-09-03 laplante@plcb.ca GOWEB/AI

title: “AI::OPENAI_INDEX” author: “laplante@plcb.ca” date: 2025-09-03 version: “1.0.0” section: “1g

category: “GOWEB/AI”

Name

ai::openai_index — Index documentation

Synopsis

ai::openai_index(directory, [apikey: string, index: file, emb_model: string])

Description

The ai::openai_index is use to index files in a directory in markdown format

Parameters

Here are the current possible values (as of 2025) based on OpenAI’s official API:

⸻

🔹 Embedding Models (EmbModel)

Used with the Embeddings API (client.Embeddings.Create):

•	"text-embedding-3-large" Dimension: 3072 Best quality embeddings, larger vector size.
•	"text-embedding-3-small" Dimension: 1536 Cheaper, smaller embeddings.
•	(Legacy, still available but deprecated)
•	"text-embedding-ada-002" → 1536 dimensions.

⸻

🔹 Chat / Completion Models (ChatModel)

Used with the Chat Completions API (client.Chat.Completions.Create):

GPT-4.1 family

•	"gpt-4.1" — Most capable, reasoning-focused model.
•	"gpt-4.1-mini" — Cheaper, faster, still very capable.

GPT-4 Turbo (older generation, still around in 2025 for some orgs)

•	"gpt-4-turbo"
•	"gpt-4-32k" (legacy)
•	"gpt-4" (legacy)

GPT-3.5 family

•	"gpt-3.5-turbo"
•	"gpt-3.5" (older, mostly replaced by turbo versions).

⸻

🔹 Special Models

•	"o1-preview", "o1-mini" — reasoning models (successors to GPT-4).
•	"gpt-4o" and "gpt-4o-mini" — multimodal Omni models (text, image, audio).

⸻

Examples

res={{
    openai_index("doc", index:"index.json");

    openai_prompt(index:"index.json", 
        intro: "Tu es un assistant utile. Réponds en français, en citant les sources sous forme de liste à la fin (chemins de fichiers). N'invente pas de faits qui ne sont pas dans le contexte.\n\n",
        "Fonction pour indexer une suite document pour utiliser avec openai");


}}.

return

res={"answer":"Pour indexer une suite de documents à utiliser avec OpenAI, il est recommandé d'utiliser la fonction **ai::openai_index**. Cette fonction permet de créer un index qui peut être référencé dans des requêtes ultérieures. Voici un résumé de son utilisation :\n\n### Fonctionnalités de **ai::openai_index** :\n\n- **Nom** : ai::openai_index\n- **Description** : Documentation de l'index.\n- **Date de création** : 2025-09-03\n- **Auteur** : laplante@plcb.ca\n- **Catégorie** : GOWEB/AI\n- **Version** : 1.0.0\n\nLa fonction est probablement conçue pour recevoir des documents et générer un index à partir de ceux-ci, facilitant ainsi une recherche et une récupération efficaces des informations.\n\n### Syntaxe de la fonction pour utiliser avec OpenAI :\n\nPour utiliser l'index créé, on se réfère aux paramètres suivants de l'API :\n\n- **prompt** : Contenu à traiter.\n- **apikey** : Clé d'API pour OpenAI.\n- **index** : L'emplacement du fichier d'index (par défaut : index.json).\n- **intro** : Introduction pour le prompt.\n- **emb_model** : Modèle d'embedding à utiliser.\n- **chat_model** : Modèle de chat à utiliser.\n\n### Références :\n1. Fichier : doc/openai_index.html — AI::_OPENAI_INDEX\n2. Fichier : doc/openai_prompt.html — AI::_OPENAI_PROMPT\n\nCes références vous fourniront plus de détails sur l'indexation et l'utilisation des API d'OpenAI.","reference":["doc/openai_index.html: AI::_OPENAI_INDEX 1g 2024-09-03 laplante@plcb.ca GOWEB/AI","doc/openai_prompt.html: AI::_OPENAI_PROMPT 1g 2024-09-01 laplante@plcb.ca GOWEB/AI","doc/ai-functions.html: AI::FUNCTIONS 1g 2023-12-25 laplante@plcb.ca GOWEB/AI"]}.

Author

laplante@plcb.ca

See also

Version