Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions es.json
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@
"groups": [
{
"group": "Referencia de la API",
"icon": "file-json",
"icon": "file-braces",
"pages": [
"es/api/introduction"
]
Expand Down Expand Up @@ -385,7 +385,13 @@
"group": "assistant",
"icon": "bot-message-square",
"pages": [
"es/api/assistant/create-assistant-message-v2",
"es/api/assistant/create-assistant-message-v2"
]
},
{
"group": "Búsqueda",
"icon": "search",
"pages": [
"es/api/assistant/search",
"es/api/assistant/get-page-content"
]
Expand Down
5 changes: 3 additions & 2 deletions es/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ La REST (Representational State Transfer) API de Mintlify te permite interactuar
* **Integración CI/CD**: Actualiza la documentación como parte de tu pipeline de implementación cuando el código cambie con [Trigger update](/es/api/update/trigger).
* **Implementaciones de vista previa**: Crea o actualiza implementaciones de vista previa de forma programática en tu pipeline CI/CD con [Trigger preview deployment](/es/api/preview/trigger).
* **Automatizaciones bajo demanda**: Activa automatizaciones programadas desde tu pipeline CI/CD, scripts de versión u otras herramientas con [Trigger automation](/es/api/automations/trigger).
* **Integraciones personalizadas**: Inserta el Asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message-v2), [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content).
* **Integraciones del asistente**: Inserta el asistente de IA en tu producto, portal de soporte o herramientas internas con [Create assistant message](/es/api/assistant/create-assistant-message-v2).
* **Recuperación de documentación**: Busca y recupera documentación para experiencias de búsqueda personalizadas con [Search documentation](/es/api/assistant/search) y [Get page content](/es/api/assistant/get-page-content).
* **Edición automatizada**: Usa trabajos de agente para actualizar la documentación programáticamente y a escala con [Create agent job](/es/api/agent/v2/create-agent-job), [Get agent job](/es/api/agent/v2/get-agent-job) y [Send follow-up message](/es/api/agent/v2/send-message).
* **Exportación de Analytics**: Exporta comentarios, conversaciones del assistant y datos de visitantes para análisis externo con [Get user feedback](/es/api/analytics/feedback), [Get assistant conversations](/es/api/analytics/assistant-conversations) y [Get assistant caller stats](/es/api/analytics/assistant-caller-stats).

Expand Down Expand Up @@ -80,5 +81,5 @@ Usa la key del Assistant API para autenticar solicitudes a los endpoints [Create
Las keys del Assistant API comienzan con el prefijo `mint_dsc_`.

<Note>
Las llamadas que usan el token del Assistant API pueden generar costos: ya sea usando tus créditos del assistant o incurriendo en excedentes.
Las solicitudes de Search documentation y Get page content no consumen créditos. Las solicitudes de Create assistant message usan créditos y pueden generar excedentes.
</Note>
6 changes: 3 additions & 3 deletions es/discovery-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@
"/v1/page/{domain}": {
"post": {
"summary": "Obtener contenido de la página",
"description": "Recupera el contenido de texto completo de una página de documentación específica por su ruta. Úsalo después de una búsqueda para obtener el contenido completo de una página coincidente.\n\nAutentícate con una clave de API del assistant.",
"description": "Recupera el contenido de texto completo de una página de documentación específica por su ruta. Úsalo después de una búsqueda para obtener el contenido completo de una página coincidente.\n\nAutentícate con una clave de API del assistant. Las solicitudes de contenido de página no consumen créditos.",
"parameters": [
{
"name": "domain",
Expand All @@ -767,7 +767,7 @@
"properties": {
"path": {
"type": "string",
"description": "El slug o ruta de la página cuyo contenido se desea recuperar. Corresponde al campo `page` devuelto por el endpoint [Search documentation](/es/api/assistant/search)."
"description": "El slug o ruta de la página cuyo contenido se desea recuperar. Corresponde al campo `path` devuelto por el endpoint [Search documentation](/es/api/assistant/search)."
}
}
}
Expand Down Expand Up @@ -822,7 +822,7 @@
}
},
"summary": "Buscar en la documentación",
"description": "Realiza búsquedas semánticas y por palabras clave en tu documentación, con filtrado y paginación configurables.\n\nAutentícate con una clave de API del assistant.",
"description": "Realiza búsquedas semánticas y por palabras clave en tu documentación, con filtrado y paginación configurables.\n\nAutentícate con una clave de API del assistant. Las solicitudes de búsqueda no consumen créditos.",
"parameters": [
{
"name": "domain",
Expand Down
10 changes: 8 additions & 2 deletions fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@
"groups": [
{
"group": "Référence de l’API",
"icon": "file-json",
"icon": "file-braces",
"pages": [
"fr/api/introduction"
]
Expand Down Expand Up @@ -385,7 +385,13 @@
"group": "Assistant",
"icon": "bot-message-square",
"pages": [
"fr/api/assistant/create-assistant-message-v2",
"fr/api/assistant/create-assistant-message-v2"
]
},
{
"group": "Recherche",
"icon": "search",
"pages": [
"fr/api/assistant/search",
"fr/api/assistant/get-page-content"
]
Expand Down
5 changes: 3 additions & 2 deletions fr/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ L'API REST (Representational State Transfer) de Mintlify vous permet d'interagir
* **Intégration CI/CD** : Mettez à jour la documentation dans le cadre de votre pipeline de déploiement lorsque le code change avec [Trigger update](/fr/api/update/trigger).
* **Déploiements de prévisualisation** : Créez ou mettez à jour des déploiements de prévisualisation de manière programmatique dans votre pipeline CI/CD avec [Trigger preview deployment](/fr/api/preview/trigger).
* **Automatisations à la demande** : Exécutez des automatisations planifiées depuis vos propres outils, comme un pipeline CI/CD ou un script de version, avec [Trigger automation](/fr/api/automations/trigger).
* **Intégrations personnalisées** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2), [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content).
* **Intégrations de l'Assistant** : Intégrez l'Assistant IA à votre produit, portail d'assistance ou outils internes avec [Create assistant message](/fr/api/assistant/create-assistant-message-v2).
* **Récupération de la documentation** : Recherchez et récupérez la documentation pour des expériences de recherche personnalisées avec [Search documentation](/fr/api/assistant/search) et [Get page content](/fr/api/assistant/get-page-content).
* **Édition automatisée** : Utilisez des jobs d'agent pour mettre à jour la documentation de manière programmatique et à grande échelle avec [Create agent job](/fr/api/agent/v2/create-agent-job), [Get agent job](/fr/api/agent/v2/get-agent-job), et [Send follow-up message](/fr/api/agent/v2/send-message).
* **Export Analytics** : Exportez les retours utilisateurs, les conversations de l'Assistant et les données de visiteurs pour une analyse externe avec [Get user feedback](/fr/api/analytics/feedback), [Get assistant conversations](/fr/api/analytics/assistant-conversations) et [Get assistant caller stats](/fr/api/analytics/assistant-caller-stats).

Expand Down Expand Up @@ -80,5 +81,5 @@ Utilisez la clé d'API de l'Assistant pour authentifier les requêtes vers les p
Les clés d'API de l'Assistant commencent par le préfixe `mint_dsc_`.

<Note>
Les appels utilisant le token de l'API de l'Assistant peuvent entraîner des coûts : soit en utilisant vos crédits d'Assistant, soit en engendrant des dépassements.
Les requêtes Search documentation et Get page content ne consomment pas de crédits. Les requêtes Create assistant message utilisent des crédits et peuvent entraîner des dépassements.
</Note>
6 changes: 3 additions & 3 deletions fr/discovery-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@
"/v1/page/{domain}": {
"post": {
"summary": "Obtenir le contenu de la page",
"description": "Récupérez le contenu textuel complet d'une page de documentation spécifique par son chemin. Utilisez-le après une recherche pour obtenir le contenu complet d'une page correspondante.\n\nAuthentifiez-vous avec une clé d'API assistant.",
"description": "Récupérez le contenu textuel complet d'une page de documentation spécifique par son chemin. Utilisez-le après une recherche pour obtenir le contenu complet d'une page correspondante.\n\nAuthentifiez-vous avec une clé d'API assistant. Les requêtes de contenu de page ne consomment pas de crédits.",
"parameters": [
{
"name": "domain",
Expand All @@ -767,7 +767,7 @@
"properties": {
"path": {
"type": "string",
"description": "Le slug ou chemin de la page dont le contenu doit être récupéré. Cela correspond au champ `page` renvoyé par l'endpoint [Search documentation](/fr/api/assistant/search)."
"description": "Le slug ou chemin de la page dont le contenu doit être récupéré. Cela correspond au champ `path` renvoyé par l'endpoint [Search documentation](/fr/api/assistant/search)."
}
}
}
Expand Down Expand Up @@ -822,7 +822,7 @@
}
},
"summary": "Rechercher dans la documentation",
"description": "Effectuez des recherches sémantiques et par mots-clés dans votre documentation, avec un filtrage et une pagination configurables.\n\nAuthentifiez-vous avec une clé d'API assistant.",
"description": "Effectuez des recherches sémantiques et par mots-clés dans votre documentation, avec un filtrage et une pagination configurables.\n\nAuthentifiez-vous avec une clé d'API assistant. Les requêtes de recherche ne consomment pas de crédits.",
"parameters": [
{
"name": "domain",
Expand Down
10 changes: 8 additions & 2 deletions zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@
"groups": [
{
"group": "API 参考",
"icon": "file-json",
"icon": "file-braces",
"pages": [
"zh/api/introduction"
]
Expand Down Expand Up @@ -380,7 +380,13 @@
"group": "AI 助手",
"icon": "bot-message-square",
"pages": [
"zh/api/assistant/create-assistant-message-v2",
"zh/api/assistant/create-assistant-message-v2"
]
},
{
"group": "搜索",
"icon": "search",
"pages": [
"zh/api/assistant/search",
"zh/api/assistant/get-page-content"
]
Expand Down
5 changes: 3 additions & 2 deletions zh/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Mintlify 的 REST(Representational State Transfer)API 让你可以以编程
* **CI/CD 集成**:在代码变更时,将文档更新作为部署流水线的一部分来执行,使用 [Trigger update](/zh/api/update/trigger)。
* **预览部署**:使用 [Trigger preview deployment](/zh/api/preview/trigger),在 CI/CD 流水线中以编程方式创建或更新预览部署。
* **按需自动化**:使用 [Trigger automation](/zh/api/automations/trigger),从 CI/CD 流水线、发布脚本或内部工具中按需运行计划自动化。
* **自定义集成**:使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2)、[Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content),将 AI 助手嵌入到你的产品、支持门户或内部工具中。
* **助手集成**:使用 [Create assistant message](/zh/api/assistant/create-assistant-message-v2),将 AI 助手嵌入到你的产品、支持门户或内部工具中。
* **文档检索**:使用 [Search documentation](/zh/api/assistant/search) 和 [Get page content](/zh/api/assistant/get-page-content),为自定义搜索体验查找和检索文档。
* **自动化编辑**:使用 agent 任务,以编程方式大规模更新文档,配合 [Create agent job](/zh/api/agent/v2/create-agent-job)、[Get agent job](/zh/api/agent/v2/get-agent-job) 和 [Send follow-up message](/zh/api/agent/v2/send-message)。
* **Analytics 导出**:使用 [Get user feedback](/zh/api/analytics/feedback)、[Get assistant conversations](/zh/api/analytics/assistant-conversations) 和 [Get assistant caller stats](/zh/api/analytics/assistant-caller-stats),导出反馈、助手会话和调用方统计数据以进行外部分析。

Expand Down Expand Up @@ -80,5 +81,5 @@ https://api.mintlify.com
assistant API key 以 `mint_dsc_` 前缀开头。

<Note>
使用 assistant API token 进行的调用可能会产生费用:可能会消耗你的助手额度,或产生超额费用
Search documentation 和 Get page content 请求不消耗额度。Create assistant message 请求会消耗额度,并可能产生超额费用
</Note>
6 changes: 3 additions & 3 deletions zh/discovery-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,7 @@
"/v1/page/{domain}": {
"post": {
"summary": "获取页面内容",
"description": "通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。\n\n使用 assistant API 密钥进行身份验证。",
"description": "通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。\n\n使用 assistant API 密钥进行身份验证。页面内容请求不消耗额度。",
"parameters": [
{
"name": "domain",
Expand All @@ -767,7 +767,7 @@
"properties": {
"path": {
"type": "string",
"description": "要检索内容的页面路径或 slug。对应于 [Search documentation](/zh/api/assistant/search) 端点返回的 `page` 字段。"
"description": "要检索内容的页面路径或 slug。对应于 [Search documentation](/zh/api/assistant/search) 端点返回的 `path` 字段。"
}
}
}
Expand Down Expand Up @@ -822,7 +822,7 @@
}
},
"summary": "搜索文档",
"description": "在你的文档中执行语义搜索和关键词搜索,并支持可配置的过滤和分页。\n\n使用 assistant API 密钥进行身份验证。",
"description": "在你的文档中执行语义搜索和关键词搜索,并支持可配置的过滤和分页。\n\n使用 assistant API 密钥进行身份验证。搜索请求不消耗额度。",
"parameters": [
{
"name": "domain",
Expand Down