diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index c52a3137e..80d5ece80 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -14,10 +14,15 @@ Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto Si tu sitio requiere autenticación, `llms.txt` y `llms-full.txt` también requieren autenticación para poder verse. Los LLM y las herramientas de IA que no puedan autenticarse en tu sitio no pueden acceder a estos archivos. Los archivos excluyen las páginas que pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups). -Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentación. +Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentación. Mintlify también aloja el archivo en `/.well-known/llms.txt` para garantizar la compatibilidad con herramientas que siguen la convención `.well-known`. Abrir el llms.txt de este sitio. +Mintlify añade encabezados HTTP a cada respuesta de página para que las herramientas de IA puedan descubrir tus archivos `llms.txt` sin conocer previamente su ubicación: + +- `Link: ; rel="llms-txt", ; rel="llms-full-txt"`: Sigue el formato estándar del encabezado HTTP `Link` para el descubrimiento de recursos. +- `X-Llms-Txt: /llms.txt`: Un encabezado de conveniencia para herramientas que verifican la compatibilidad con `llms.txt`. +
## Estructura de llms.txt
@@ -28,27 +33,30 @@ Un archivo `llms.txt` es un archivo Markdown sin formato que contiene: * **Secciones de contenido estructuradas** con enlaces y una descripción de cada página de tu documentación. * **Enlaces a especificaciones de API** a tus especificaciones OpenAPI y AsyncAPI, si tu documentación las incluye. -El archivo `llms.txt` lista tus páginas alfabéticamente en el orden en que aparecen en tu repositorio, comenzando desde el directorio raíz. +El archivo `llms.txt` lista tus páginas alfabéticamente en el orden en que aparecen en tu repositorio, comenzando desde el directorio raíz. Los enlaces de las páginas en el archivo `llms.txt` incluyen la extensión `.md` para que las herramientas de IA puedan obtener directamente la versión Markdown de cada página. La descripción de cada página proviene del campo `description` en su frontmatter. Las descripciones se truncan a 300 caracteres y al primer salto de línea. Para las páginas de referencia de API, la descripción también incluye la información de la especificación del campo `openapi` o `api` del frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción. +Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA. + ```mdx Example llms.txt # Título del sitio ## Documentación -- [API](https://example.com/docs/api): Lista de endpoints y uso -- [Instalar](https://example.com/docs/install): Pasos de configuración -- [Primeros pasos](https://example.com/docs/start): Guía de introducción +- [API](https://example.com/docs/api.md): Lista de endpoints y uso +- [Instalar](https://example.com/docs/install.md): Pasos de configuración +- [Primeros pasos](https://example.com/docs/start.md): Guía de introducción -## Especificaciones de API +## OpenAPI Specs - [openapi](https://example.com/docs/openapi.json) + +## AsyncAPI Specs + - [asyncapi](https://example.com/docs/asyncapi.yaml) ``` -Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA. -
## llms-full.txt
@@ -65,4 +73,4 @@ Mintlify aloja automáticamente un archivo `llms-full.txt` en la raíz de tu pro Para agregar un archivo personalizado `llms.txt` o `llms-full.txt`, crea un archivo `llms.txt` o `llms-full.txt` en la raíz de tu proyecto. Agregar un archivo personalizado reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, Mintlify restaura el archivo generado automáticamente. -Tu archivo personalizado `llms.txt` o `llms-full.txt` debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Format](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre secciones opcionales y buenas prácticas. \ No newline at end of file +Tu archivo personalizado `llms.txt` o `llms-full.txt` debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Format](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre secciones opcionales y buenas prácticas. diff --git a/es/ai/markdown-export.mdx b/es/ai/markdown-export.mdx index 561a1e98b..00786f438 100644 --- a/es/ai/markdown-export.mdx +++ b/es/ai/markdown-export.mdx @@ -19,8 +19,18 @@ Añade `.md` a la URL de cualquier página para ver una versión en Markdown. Abrir esta página como Markdown +
+ ## Encabezado Accept +
+ +Envía una solicitud con `Accept: text/markdown` o `Accept: text/plain` a la URL de cualquier página para recibir la versión Markdown en lugar de HTML. Esto es útil para herramientas de IA e integraciones que obtienen contenido de documentación de forma programática. + +```bash +curl -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export +``` +
## Atajo de teclado
-Pulsa Command + C (Ctrl + C en Windows) para copiar una página en Markdown al portapapeles. \ No newline at end of file +Pulsa Command + C (Ctrl + C en Windows) para copiar una página en Markdown al portapapeles. diff --git a/es/ai/skillmd.mdx b/es/ai/skillmd.mdx index a5f03f4ad..8375cdba2 100644 --- a/es/ai/skillmd.mdx +++ b/es/ai/skillmd.mdx @@ -26,7 +26,7 @@ Consulta tu `skill.md` añadiendo `/skill.md` a la URL de tu sitio de documentac - Si utilizas un [proxy inverso](/es/deploy/reverse-proxy), configúralo para reenviar las rutas `/skill.md` y `/.well-known/skills/*` (con el almacenamiento en caché deshabilitado) a tu subdominio de Mintlify. + Si utilizas un [proxy inverso](/es/deploy/reverse-proxy), configúralo para reenviar las rutas `/skill.md` y `/.well-known/skills/*` a tu subdominio de Mintlify. Los agentes pueden procesar tu archivo `skill.md` con la [CLI de skills](https://www.npmjs.com/package/skills). @@ -88,3 +88,35 @@ metadata: version: "1.0" --- ``` + +
+ ## Endpoints de descubrimiento de skills +
+ +Mintlify aloja un directorio de skills en `/.well-known/skills/` que los agentes pueden usar para descubrir y obtener tus archivos de skills de forma programática. + +
+ ### Índice de skills +
+ +`GET /.well-known/skills/index.json` devuelve un manifiesto JSON con la lista de todas las skills disponibles: + +```json +{ + "skills": [ + { + "name": "my-product", + "description": "A brief description of what your skill does.", + "files": ["SKILL.md"] + } + ] +} +``` + +El campo `name` es un slug seguro para URL derivado del campo `name` en el frontmatter de tu `skill.md`. + +
+ ### Archivos de skills individuales +
+ +`GET /.well-known/skills/{name}/skill.md` devuelve el archivo `skill.md` de una skill específica identificada por su nombre slugificado del índice. diff --git a/es/api/assistant/create-assistant-message-v2.mdx b/es/api/assistant/create-assistant-message-v2.mdx index 218d0edbe..c41816ed0 100644 --- a/es/api/assistant/create-assistant-message-v2.mdx +++ b/es/api/assistant/create-assistant-message-v2.mdx @@ -16,7 +16,7 @@ keywords: --- - El endpoint de mensaje de assistant v2 es compatible con **AI SDK v5 o superior**. Si usas AI SDK v4, utiliza en su lugar el [endpoint de mensaje de assistant v1](/es/api-reference/assistant/create-assistant-message). + El endpoint de mensaje de assistant v2 es compatible con **AI SDK v5 o superior**. Si usas AI SDK v4, utiliza en su lugar el [endpoint de mensaje de assistant v1](/es/api/assistant/create-assistant-message).
diff --git a/es/api/assistant/create-assistant-message.mdx b/es/api/assistant/create-assistant-message.mdx index c0ca20a7d..646f94298 100644 --- a/es/api/assistant/create-assistant-message.mdx +++ b/es/api/assistant/create-assistant-message.mdx @@ -10,7 +10,7 @@ keywords: [ "mensaje del assistant", "incrustar", "chat", "integrar", "ai sdk v4 En desuso - El endpoint assistant message v1 es compatible con **AI SDK v4**. Si utilizas AI SDK v5 o posterior, usa en su lugar el [endpoint assistant message v2](/es/api-reference/assistant/create-assistant-message-v2). + El endpoint assistant message v1 es compatible con **AI SDK v4**. Si utilizas AI SDK v5 o posterior, usa en su lugar el [endpoint assistant message v2](/es/api/assistant/create-assistant-message-v2).
diff --git a/fr/ai/llmstxt.mdx b/fr/ai/llmstxt.mdx index f66522530..86adc1d68 100644 --- a/fr/ai/llmstxt.mdx +++ b/fr/ai/llmstxt.mdx @@ -1,61 +1,69 @@ --- title: "llms.txt" -description: "Générez automatiquement les fichiers llms.txt et llms-full.txt pour aider les outils d’IA à indexer et à comprendre votre documentation." +description: "Générez automatiquement les fichiers llms.txt et llms-full.txt pour aider les outils d'IA à indexer et à comprendre votre documentation." keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"] --- import { PreviewButton } from "/snippets/previewbutton.jsx" -Le [fichier llms.txt](https://llmstxt.org) est une norme du secteur qui aide les LLM à indexer le contenu plus efficacement, comme un sitemap le fait pour les moteurs de recherche. Les outils d’IA peuvent utiliser ce fichier pour comprendre la structure de votre documentation et trouver le contenu pertinent pour les requêtes des utilisateurs. +Le [fichier llms.txt](https://llmstxt.org) est une norme du secteur qui aide les LLM à indexer le contenu plus efficacement, comme un sitemap le fait pour les moteurs de recherche. Les outils d'IA peuvent utiliser ce fichier pour comprendre la structure de votre documentation et trouver le contenu pertinent pour les requêtes des utilisateurs. Mintlify héberge automatiquement, à la racine de votre projet, un fichier `llms.txt` qui répertorie toutes les pages disponibles de votre documentation. Ce fichier est toujours à jour et ne nécessite aucun entretien. Vous pouvez également ajouter un fichier `llms.txt` personnalisé à la racine de votre projet. - Si votre site nécessite une authentification, `llms.txt` et `llms-full.txt` sont également soumis à une authentification pour être consultés. Les LLM et les outils d’IA qui ne peuvent pas s’authentifier sur votre site ne peuvent pas accéder à ces fichiers. Les fichiers excluent les pages qui appartiennent à des [groupes d’utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups). + Si votre site nécessite une authentification, `llms.txt` et `llms-full.txt` sont également soumis à une authentification pour être consultés. Les LLM et les outils d'IA qui ne peuvent pas s'authentifier sur votre site ne peuvent pas accéder à ces fichiers. Les fichiers excluent les pages qui appartiennent à des [groupes d'utilisateurs](/fr/deploy/authentication-setup#control-access-with-groups). -Affichez votre `llms.txt` en ajoutant `/llms.txt` à l’URL de votre site de documentation. +Affichez votre `llms.txt` en ajoutant `/llms.txt` à l'URL de votre site de documentation. Mintlify héberge également le fichier à l'emplacement `/.well-known/llms.txt` pour assurer la compatibilité avec les outils qui suivent la convention `.well-known`. Ouvrir le llms.txt de ce site. +Mintlify ajoute des en-têtes HTTP à chaque réponse de page afin que les outils d'IA puissent découvrir vos fichiers `llms.txt` sans connaître au préalable leur emplacement : + +- `Link: ; rel="llms-txt", ; rel="llms-full-txt"` : Suit le format standard de l'en-tête HTTP `Link` pour la découverte de ressources. +- `X-Llms-Txt: /llms.txt` : Un en-tête pratique pour les outils qui vérifient la prise en charge de `llms.txt`. +
## Structure de llms.txt
-Un fichier `llms.txt` est un simple fichier Markdown qui contient : +Un fichier `llms.txt` est un simple fichier Markdown qui contient : * **Le titre du site** en tant que H1. * **Des sections de contenu structurées** avec des liens et une description de chaque page de votre documentation. -* **Des liens vers les spécifications d'API** pointant vers vos spécifications OpenAPI et AsyncAPI, si votre documentation en inclut. +* **Des liens vers les spécifications d'API** pointant vers vos spécifications OpenAPI et AsyncAPI, si votre documentation en inclut. + +Le fichier `llms.txt` répertorie vos pages par ordre alphabétique selon leur emplacement dans votre référentiel, en commençant au répertoire racine. Les liens des pages dans le fichier `llms.txt` incluent une extension `.md` afin que les outils d'IA puissent récupérer directement la version Markdown de chaque page. -Le fichier `llms.txt` répertorie vos pages par ordre alphabétique selon leur emplacement dans votre référentiel, en commençant au répertoire racine. +La description de chaque page provient du champ `description` de son frontmatter. Les descriptions sont tronquées à 300 caractères et au premier saut de ligne. Pour les pages de référence d'API, la description inclut également les informations de spécification issues du champ de frontmatter `openapi` ou `api`. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description. -La description de chaque page provient du champ `description` de son frontmatter. Les descriptions sont tronquées à 300 caractères et au premier saut de ligne. Pour les pages de référence d'API, la description inclut également les informations de spécification issues du champ de frontmatter `openapi` ou `api`. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description. +Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l'IA. ```mdx Example llms.txt # Titre du site ## Documentation -- [API](https://example.com/docs/api) : Liste des endpoints et utilisation -- [Installation](https://example.com/docs/install) : Étapes de configuration -- [Prise en main](https://example.com/docs/start) : Guide d'introduction +- [API](https://example.com/docs/api.md) : Liste des endpoints et utilisation +- [Installation](https://example.com/docs/install.md) : Étapes de configuration +- [Prise en main](https://example.com/docs/start.md) : Guide d'introduction -## Spécifications API +## OpenAPI Specs - [openapi](https://example.com/docs/openapi.json) + +## AsyncAPI Specs + - [asyncapi](https://example.com/docs/asyncapi.yaml) ``` -Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l’IA. -
## llms-full.txt
-Le fichier `llms-full.txt` regroupe l’intégralité de votre site de documentation en un seul fichier servant de contexte pour les outils d’IA et l’indexation par les LLM. +Le fichier `llms-full.txt` regroupe l'intégralité de votre site de documentation en un seul fichier servant de contexte pour les outils d'IA et l'indexation par les LLM. -Mintlify héberge automatiquement un fichier `llms-full.txt` à la racine de votre projet. Affichez votre `llms-full.txt` en ajoutant `/llms-full.txt` à l’URL de votre site de documentation. Mintlify héberge également le fichier à l’emplacement `/.well-known/llms-full.txt` pour assurer la compatibilité avec les outils qui suivent la convention `.well-known`. +Mintlify héberge automatiquement un fichier `llms-full.txt` à la racine de votre projet. Affichez votre `llms-full.txt` en ajoutant `/llms-full.txt` à l'URL de votre site de documentation. Mintlify héberge également le fichier à l'emplacement `/.well-known/llms-full.txt` pour assurer la compatibilité avec les outils qui suivent la convention `.well-known`. Ouvrir le llms-full.txt de ce site @@ -63,6 +71,6 @@ Mintlify héberge automatiquement un fichier `llms-full.txt` à la racine de vot ## Fichiers personnalisés
-Pour ajouter un fichier `llms.txt` ou `llms-full.txt` personnalisé, créez un fichier `llms.txt` ou `llms-full.txt` à la racine de votre projet. L’ajout d’un fichier personnalisé remplace le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, Mintlify restaure le fichier généré automatiquement. +Pour ajouter un fichier `llms.txt` ou `llms-full.txt` personnalisé, créez un fichier `llms.txt` ou `llms-full.txt` à la racine de votre projet. L'ajout d'un fichier personnalisé remplace le fichier généré automatiquement portant le même nom. Si vous supprimez un fichier personnalisé, Mintlify restaure le fichier généré automatiquement. -Votre fichier `llms.txt` ou `llms-full.txt` personnalisé doit comporter le titre du site en tant que niveau de titre H1. Le reste du contenu est facultatif. Consultez [Format](https://llmstxt.org/#format) dans la spécification `llms.txt` pour plus d’informations sur les sections facultatives et les bonnes pratiques. \ No newline at end of file +Votre fichier `llms.txt` ou `llms-full.txt` personnalisé doit comporter le titre du site en tant que niveau de titre H1. Le reste du contenu est facultatif. Consultez [Format](https://llmstxt.org/#format) dans la spécification `llms.txt` pour plus d'informations sur les sections facultatives et les bonnes pratiques. diff --git a/fr/ai/markdown-export.mdx b/fr/ai/markdown-export.mdx index c52350c86..7c22289b8 100644 --- a/fr/ai/markdown-export.mdx +++ b/fr/ai/markdown-export.mdx @@ -1,26 +1,36 @@ --- title: "Export Markdown" -description: "Obtenez rapidement des versions Markdown de vos pages pour les outils d’IA et les intégrations." +description: "Obtenez rapidement des versions Markdown de vos pages pour les outils d'IA et les intégrations." keywords: ["markdown", "efficacité des jetons", "traitement par IA"] --- import { PreviewButton } from "/snippets/previewbutton.jsx" -Markdown fournit un texte structuré que les outils d’IA peuvent traiter plus efficacement que le HTML, ce qui se traduit par une meilleure précision des réponses, des temps de traitement plus rapides et une consommation de jetons réduite. +Markdown fournit un texte structuré que les outils d'IA peuvent traiter plus efficacement que le HTML, ce qui se traduit par une meilleure précision des réponses, des temps de traitement plus rapides et une consommation de jetons réduite. -Mintlify génère automatiquement des versions Markdown des pages, optimisées pour les outils d’IA et les intégrations externes. +Mintlify génère automatiquement des versions Markdown des pages, optimisées pour les outils d'IA et les intégrations externes.
- ## Extension d’URL .md + ## Extension d'URL .md
-Ajoutez `.md` à l’URL de n’importe quelle page pour afficher une version Markdown. +Ajoutez `.md` à l'URL de n'importe quelle page pour afficher une version Markdown. Ouvrir cette page au format Markdown +
+ ## En-tête Accept +
+ +Envoyez une requête avec `Accept: text/markdown` ou `Accept: text/plain` à l'URL de n'importe quelle page pour recevoir la version Markdown au lieu du HTML. Cela est utile pour les outils d'IA et les intégrations qui récupèrent le contenu de la documentation de manière programmatique. + +```bash +curl -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export +``` +
## Raccourci clavier
-Appuyez sur Command + C (Ctrl + C sous Windows) pour copier une page au format Markdown dans le presse-papiers. \ No newline at end of file +Appuyez sur Command + C (Ctrl + C sous Windows) pour copier une page au format Markdown dans le presse-papiers. diff --git a/fr/ai/skillmd.mdx b/fr/ai/skillmd.mdx index 3205060f3..7043e6c01 100644 --- a/fr/ai/skillmd.mdx +++ b/fr/ai/skillmd.mdx @@ -1,24 +1,24 @@ --- title: "skill.md" description: "Générez automatiquement des fichiers skill.md décrivant les capacités de votre produit pour les agents d'IA." -keywords: ["agents IA", "compétences", "compétences d’agent", "agents"] +keywords: ["agents IA", "compétences", "compétences d'agent", "agents"] --- -Mintlify héberge un fichier `skill.md` à la racine de votre projet qui décrit ce que les agents d’IA peuvent faire avec votre produit. +Mintlify héberge un fichier `skill.md` à la racine de votre projet qui décrit ce que les agents d'IA peuvent faire avec votre produit. La [spécification skill.md](https://agentskills.io/specification) est un format structuré et lisible par les machines qui rend explicites les capacités, les entrées requises et les contraintes des produits afin que les agents puissent les utiliser de manière plus fiable. Mintlify génère automatiquement un fichier `skill.md` pour votre projet en analysant votre documentation avec une boucle pilotée par des agents. Ce fichier reste à jour à mesure que vous mettez à jour votre documentation et ne nécessite aucune maintenance. Vous pouvez également ajouter un fichier `skill.md` personnalisé à la racine de votre projet qui remplace celui généré automatiquement. -Affichez votre `skill.md` en ajoutant `/skill.md` à l’URL de votre site de documentation. Mintlify ne génère des fichiers `skill.md` que pour les sites de documentation publics. +Affichez votre `skill.md` en ajoutant `/skill.md` à l'URL de votre site de documentation. Mintlify ne génère des fichiers `skill.md` que pour les sites de documentation publics. Ouvrir le skill.md de ce site. Les fichiers `llms.txt` et `skill.md` aident tous deux les agents à travailler avec votre documentation, mais ils ont des objectifs différents. - * `llms.txt` est un index. Il répertorie toutes les pages de votre documentation avec des descriptions pour que les agents sachent où trouver l’information. - * `skill.md` est un résumé de capacités. Il indique aux agents ce qu’ils peuvent accomplir avec votre produit, quelles entrées sont nécessaires et quelles contraintes s’appliquent. + * `llms.txt` est un index. Il répertorie toutes les pages de votre documentation avec des descriptions pour que les agents sachent où trouver l'information. + * `skill.md` est un résumé de capacités. Il indique aux agents ce qu'ils peuvent accomplir avec votre produit, quelles entrées sont nécessaires et quelles contraintes s'appliquent.
@@ -26,7 +26,7 @@ Affichez votre `skill.md` en ajoutant `/skill.md` à l’URL de votre site de do
- Si vous utilisez un [proxy inverse](/fr/deploy/reverse-proxy), configurez-le pour qu’il redirige les chemins `/skill.md` et `/.well-known/skills/*` (avec la mise en cache désactivée) vers votre sous-domaine Mintlify. + Si vous utilisez un [proxy inverse](/fr/deploy/reverse-proxy), configurez-le pour qu'il redirige les chemins `/skill.md` et `/.well-known/skills/*` vers votre sous-domaine Mintlify. Les agents peuvent traiter votre fichier `skill.md` avec la [CLI skills](https://www.npmjs.com/package/skills). @@ -35,24 +35,24 @@ Les agents peuvent traiter votre fichier `skill.md` avec la [CLI skills](https:/ npx skills add https://your-docs-domain.com ``` -Cela ajoute les capacités de votre produit au contexte de l’agent afin qu’il puisse effectuer des actions au nom des utilisateurs. +Cela ajoute les capacités de votre produit au contexte de l'agent afin qu'il puisse effectuer des actions au nom des utilisateurs. - Expliquez à vos utilisateurs comment utiliser les fichiers `skill.md` avec des agents afin qu’ils obtiennent de meilleurs résultats en utilisant votre produit avec leurs outils d’IA. + Expliquez à vos utilisateurs comment utiliser les fichiers `skill.md` avec des agents afin qu'ils obtiennent de meilleurs résultats en utilisant votre produit avec leurs outils d'IA.
## Structure de `skill.md`
-Mintlify génère un fichier `skill.md` selon la [spécification agentskills.io](https://agentskills.io/specification). Le fichier généré comprend : +Mintlify génère un fichier `skill.md` selon la [spécification agentskills.io](https://agentskills.io/specification). Le fichier généré comprend : -* **Metadata** : nom du projet, description et version. -* **Capacités** : ce que les agents peuvent accomplir avec votre produit. -* **Compétences** : actions spécifiques organisées par catégorie. -* **Flux de travail** : procédures étape par étape pour les tâches courantes. -* **Intégrations** : outils et services pris en charge. -* **Contexte** : informations générales sur l’architecture de votre produit. +* **Metadata** : nom du projet, description et version. +* **Capacités** : ce que les agents peuvent accomplir avec votre produit. +* **Compétences** : actions spécifiques organisées par catégorie. +* **Flux de travail** : procédures étape par étape pour les tâches courantes. +* **Intégrations** : outils et services pris en charge. +* **Contexte** : informations générales sur l'architecture de votre produit.
## Fichiers `skill.md` personnalisés @@ -72,9 +72,9 @@ Les fichiers `skill.md` personnalisés doivent commencer par un frontmatter YAML | --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Le nom de votre skill. | | `description` | string | Une brève description de ce que fait votre skill. | -| `license` | string | La licence de votre skill (par exemple : `MIT` ou `Apache-2.0`). | -| `compatibility` | string | Exigences ou notes de compatibilité (par exemple : dépendances d'exécution). | -| `metadata` | object | Métadonnées supplémentaires sous forme de paires clé-valeur de chaînes de caractères (par exemple : `author` ou `version`). | +| `license` | string | La licence de votre skill (par exemple : `MIT` ou `Apache-2.0`). | +| `compatibility` | string | Exigences ou notes de compatibilité (par exemple : dépendances d'exécution). | +| `metadata` | object | Métadonnées supplémentaires sous forme de paires clé-valeur de chaînes de caractères (par exemple : `author` ou `version`). | | `allowed-tools` | string | Liste, séparée par des espaces, des outils préautorisés que le skill peut utiliser (expérimental). | ```md Example frontmatter @@ -88,3 +88,35 @@ metadata: version: "1.0" --- ``` + +
+ ## Endpoints de découverte des skills +
+ +Mintlify héberge un répertoire de skills à l'emplacement `/.well-known/skills/` que les agents peuvent utiliser pour découvrir et récupérer vos fichiers de skills de manière programmatique. + +
+ ### Index des skills +
+ +`GET /.well-known/skills/index.json` renvoie un manifeste JSON listant toutes les skills disponibles : + +```json +{ + "skills": [ + { + "name": "my-product", + "description": "A brief description of what your skill does.", + "files": ["SKILL.md"] + } + ] +} +``` + +Le champ `name` est un slug compatible URL dérivé du champ `name` dans le frontmatter de votre `skill.md`. + +
+ ### Fichiers de skills individuels +
+ +`GET /.well-known/skills/{name}/skill.md` renvoie le fichier `skill.md` d'une skill spécifique identifiée par son nom slugifié depuis l'index. diff --git a/fr/api/assistant/create-assistant-message-v2.mdx b/fr/api/assistant/create-assistant-message-v2.mdx index df00b958a..f8b172fb4 100644 --- a/fr/api/assistant/create-assistant-message-v2.mdx +++ b/fr/api/assistant/create-assistant-message-v2.mdx @@ -16,7 +16,7 @@ keywords: --- - L'endpoint assistant message v2 est compatible avec **AI SDK v5+**. Si vous utilisez l'AI SDK v4, utilisez plutôt l'[endpoint assistant message v1](/fr/api-reference/assistant/create-assistant-message). + L'endpoint assistant message v2 est compatible avec **AI SDK v5+**. Si vous utilisez l'AI SDK v4, utilisez plutôt l'[endpoint assistant message v1](/fr/api/assistant/create-assistant-message).
diff --git a/fr/api/assistant/create-assistant-message.mdx b/fr/api/assistant/create-assistant-message.mdx index 1ccc44be9..979692908 100644 --- a/fr/api/assistant/create-assistant-message.mdx +++ b/fr/api/assistant/create-assistant-message.mdx @@ -11,7 +11,7 @@ keywords: [ "message de l’Assistant", "intégration", "chat", "intégrer", "ai Obsolète - Le point de terminaison assistant message v1 est compatible avec **AI SDK v4**. Si vous utilisez AI SDK v5 ou une version ultérieure, utilisez plutôt le [point de terminaison assistant message v2](/fr/api-reference/assistant/create-assistant-message-v2). + Le point de terminaison assistant message v1 est compatible avec **AI SDK v4**. Si vous utilisez AI SDK v5 ou une version ultérieure, utilisez plutôt le [point de terminaison assistant message v2](/fr/api/assistant/create-assistant-message-v2).
diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index e77801acb..65a1ce421 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -14,10 +14,15 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文 如果你的站点需要认证,查看 `llms.txt` 和 `llms-full.txt` 也同样需要认证。无法通过你站点认证的 LLM 和 AI 工具将无法访问这些文件。这些文件会排除属于[用户分组](/zh/deploy/authentication-setup#control-access-with-groups)的页面。 -将 `/llms.txt` 追加到你的文档站点 URL 后查看 `llms.txt`。 +将 `/llms.txt` 追加到你的文档站点 URL 后查看 `llms.txt`。Mintlify 还会在 `/.well-known/llms.txt` 托管该文件,以兼容采用 `.well-known` 约定的工具。 打开此站点的 llms.txt。 +Mintlify 会在每个页面的响应中添加 HTTP 标头,以便 AI 工具无需事先知道位置即可发现你的 `llms.txt` 文件: + +- `Link: ; rel="llms-txt", ; rel="llms-full-txt"`:遵循标准 HTTP `Link` 标头格式,用于资源发现。 +- `X-Llms-Txt: /llms.txt`:一个便捷标头,供检查 `llms.txt` 支持情况的工具使用。 +
## llms.txt 结构
@@ -28,27 +33,30 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文 * **结构化内容部分**,包含链接以及文档中每个页面的说明。 * 指向 OpenAPI 和 AsyncAPI 规范的 **API 规范链接** (如果文档中包含这些规范) 。 -`llms.txt` 文件会按照页面在存储库中的位置,以字母顺序列出,从根目录开始。 +`llms.txt` 文件会按照页面在存储库中的位置,以字母顺序列出,从根目录开始。`llms.txt` 文件中的页面链接包含 `.md` 扩展名,以便 AI 工具可以直接获取每个页面的 Markdown 版本。 每个页面的说明来自其 frontmatter 中的 `description` 字段。说明会在达到 300 个字符或遇到第一个换行符时被截断。对于 API 参考页面,说明中还会包含来自 `openapi` 或 `api` frontmatter 字段的规范信息。没有 `description` 字段的页面将在 `llms.txt` 中显示,但不含说明。 +这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档,并为用户查询定位相关内容,从而提升 AI 辅助文档搜索的准确性和速度。 + ```mdx Example llms.txt # 站点标题 ## 文档 -- [API](https://example.com/docs/api): 端点列表和使用方法 -- [安装](https://example.com/docs/install): 设置步骤 -- [快速开始](https://example.com/docs/start): 入门指南 +- [API](https://example.com/docs/api.md): 端点列表和使用方法 +- [安装](https://example.com/docs/install.md): 设置步骤 +- [快速开始](https://example.com/docs/start.md): 入门指南 -## API 规范 +## OpenAPI Specs - [openapi](https://example.com/docs/openapi.json) + +## AsyncAPI Specs + - [asyncapi](https://example.com/docs/asyncapi.yaml) ``` -这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档,并为用户查询定位相关内容,从而提升 AI 辅助文档搜索的准确性和速度。 -
## llms-full.txt
@@ -65,4 +73,4 @@ Mintlify 会在你的项目根目录自动托管一个 `llms-full.txt` 文件。 要添加自定义的 `llms.txt` 或 `llms-full.txt` 文件,请在项目根目录创建同名文件。添加自定义文件会覆盖同名的自动生成文件。如果你删除自定义文件,Mintlify 会恢复使用同名的自动生成文件。 -自定义的 `llms.txt` 或 `llms-full.txt` 文件必须包含一个以 H1 标题呈现的站点标题。其他内容为可选。有关可选部分和最佳实践的更多信息,请参阅 `llms.txt` 规范中的[Format](https://llmstxt.org/#format)。 \ No newline at end of file +自定义的 `llms.txt` 或 `llms-full.txt` 文件必须包含一个以 H1 标题呈现的站点标题。其他内容为可选。有关可选部分和最佳实践的更多信息,请参阅 `llms.txt` 规范中的[Format](https://llmstxt.org/#format)。 diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 903bfd967..34fd15f56 100644 --- a/zh/ai/markdown-export.mdx +++ b/zh/ai/markdown-export.mdx @@ -19,8 +19,18 @@ Mintlify 会自动生成针对 AI 工具和外部 integrations 优化的页面 M 以 Markdown 打开此页面 +
+ ## Accept 标头 +
+ +向任意页面 URL 发送带有 `Accept: text/markdown` 或 `Accept: text/plain` 的请求,即可接收 Markdown 版本而非 HTML。这对于以编程方式获取文档内容的 AI 工具和 integrations 非常有用。 + +```bash +curl -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export +``` +
## 键盘快捷键
-按 Command + C(在 Windows 上为 Ctrl + C)将页面以 Markdown 格式复制到剪贴板。 \ No newline at end of file +按 Command + C(在 Windows 上为 Ctrl + C)将页面以 Markdown 格式复制到剪贴板。 diff --git a/zh/ai/skillmd.mdx b/zh/ai/skillmd.mdx index d2c50acf5..6a59b1289 100644 --- a/zh/ai/skillmd.mdx +++ b/zh/ai/skillmd.mdx @@ -26,7 +26,7 @@ Mintlify 会通过一个 agentic loop 分析你的文档,自动为你的项目
- 如果你使用 [反向代理](/zh/deploy/reverse-proxy),请将其配置为将对 `/skill.md` 和 `/.well-known/skills/*` 路径的请求 (禁用缓存) 转发到你的 Mintlify 子域。 + 如果你使用 [反向代理](/zh/deploy/reverse-proxy),请将其配置为将对 `/skill.md` 和 `/.well-known/skills/*` 路径的请求转发到你的 Mintlify 子域。 代理可以使用 [skills 命令行界面 (CLI) ](https://www.npmjs.com/package/skills) 来处理你的 `skill.md`。 @@ -88,3 +88,35 @@ metadata: version: "1.0" --- ``` + +
+ ## Skills 发现端点 +
+ +Mintlify 在 `/.well-known/skills/` 托管了一个 skills 目录,代理可以通过该目录以编程方式发现和获取你的 skill 文件。 + +
+ ### Skills 索引 +
+ +`GET /.well-known/skills/index.json` 返回一个 JSON 清单,列出所有可用的 skills: + +```json +{ + "skills": [ + { + "name": "my-product", + "description": "A brief description of what your skill does.", + "files": ["SKILL.md"] + } + ] +} +``` + +`name` 字段是一个 URL 安全的 slug,源自你 `skill.md` frontmatter 中的 `name` 字段。 + +
+ ### 单个 skill 文件 +
+ +`GET /.well-known/skills/{name}/skill.md` 返回通过索引中 slugified 名称标识的特定 skill 的 `skill.md` 文件。 diff --git a/zh/api/assistant/create-assistant-message-v2.mdx b/zh/api/assistant/create-assistant-message-v2.mdx index 1aec76afe..1ba16a029 100644 --- a/zh/api/assistant/create-assistant-message-v2.mdx +++ b/zh/api/assistant/create-assistant-message-v2.mdx @@ -15,7 +15,7 @@ keywords: --- - assistant 消息 v2 端点兼容 **AI SDK v5+**。如果你正在使用 AI SDK v4,请改用 [assistant 消息 v1 端点](/zh/api-reference/assistant/create-assistant-message)。 + assistant 消息 v2 端点兼容 **AI SDK v5+**。如果你正在使用 AI SDK v4,请改用 [assistant 消息 v1 端点](/zh/api/assistant/create-assistant-message)。
diff --git a/zh/api/assistant/create-assistant-message.mdx b/zh/api/assistant/create-assistant-message.mdx index e91912230..4e2073d04 100644 --- a/zh/api/assistant/create-assistant-message.mdx +++ b/zh/api/assistant/create-assistant-message.mdx @@ -9,7 +9,7 @@ keywords: [ "AI 助手消息", "嵌入", "聊天", "集成", "ai sdk v4" ] 已废弃 - assistant message v1 端点与 **AI SDK v4** 兼容。若你使用 AI SDK v5 或更高版本,请改用 [assistant message v2 端点](/zh/api-reference/assistant/create-assistant-message-v2)。 + assistant message v1 端点与 **AI SDK v4** 兼容。若你使用 AI SDK v5 或更高版本,请改用 [assistant message v2 端点](/zh/api/assistant/create-assistant-message-v2)。