Obtenir des réponses dans la documentation d'IBM
watsonx Code Assistant Plan d'essai Plan essentiel Plan standard
Utilisez le chat pour poser des questions qui font référence à la documentation des produits IBM et Red Hat.
Cette fonctionnalité nécessite un IBM Cloud Essai, Essentiel ou Standard. Elle n'est pas disponible si vous utilisez watsonx Code Assistant Individual pour accéder à un modèle local IBM Granite.
Syntaxe du chat pour les questions de documentation
La syntaxe du chat est la suivante :
/docs [collection:<collection_name>] <your question>
Le site collection_name est facultatif. Si aucune collection n'est spécifiée, ibm_docs est utilisé.
Les collections de documentation disponibles sont les suivantes
| Collection | Source | Référence d'URL |
|---|---|---|
ibm_docs |
IBM Documentation | https://www.ibm.com/docs |
cloud_docs |
Documentation IBM Cloud | https://cloud.ibm.com/docs/ |
redhat |
Red Hat Documentation | https://docs.redhat.com/products |
ibm_redbooks |
IBM Redbooks publications | https://www.redbooks.ibm.com/ |
support_docs |
Contenu du support IBM | https://www.ibm.com/support/ |
general_technical_docs |
IBM Research et SecurityIntelligence | https://research.ibm.com/ https://research.ibm.com/ https://securit https://securityintelligence.com/articles |
Exemples
| Type | Exemple de question |
|---|---|
| Informations générales sur les produits | /docs what are the different IBM Cognos Analytics offerings for which IBM provides commands to? |
| Exécuter une tâche | /docs What is the command to back up a database in Db2? Enclose the command in code blocks. |
| Dépannage d'un code d'erreur | /docs collection:support_docs I am getting this error: Internal error occurred: SCAPI error: The value on row 1,029 is not a valid string while previewing a data asset using import node. Can you provide a workaround for this? |
| Interroger une collection spécifique | /docs collection:redhat What are Machine pools in Cluster administration nodes in Red Hat OpenShift dedicated? |
Conseils
Ces conseils peuvent vous aider à améliorer vos questions " /docs.
Utiliser le nom du produit
Veillez à spécifier le nom du produit. How to back up a database peut récupérer les résultats de Db2, mais 'How to back up a Db2 database est plus efficace.
Numéros de version
La source utilisée par watsonx Code Assistant contient de la documentation sur les dernières versions des produits IBM Les questions portant sur des versions plus anciennes peuvent fonctionner si vous indiquez le numéro de version dans votre requête.
Contexte
Lorsque watsonx Code Assistant répond à une question de type " /docs, il n'utilise aucun autre contexte de votre fenêtre de chat ou de vos fichiers ouverts. Le contexte est extrait de la documentation des produits IBM
La réponse à une question de type " /docs fait partie du contexte de votre chat. Votre prochaine question de chat peut utiliser la réponse de la documentation comme contexte pour aider à guider watsonx Code Assistant
Par exemple, vous pouvez demander : " /docs what is the command to back up a Db2 database. Format the command in Markdown.
Lorsque vous obtenez la réponse avec la commande, vous pouvez demander : " Create a script to back up the Db2 database REVENUE et vous devriez recevoir une réponse qui utilise la syntaxe de la commande de la documentation.