Cisco API Documentations Is Now Tailored for Gen AI Applied sciences

Developer expertise adjustments quickly. Many builders and the Cisco DevNet neighborhood make the most of Generative AI instruments and language fashions for code technology and troubleshooting.

Higher information – higher mannequin completion

The primary problem for GenAI customers is discovering legitimate information for his or her prompts or Vector Databases. Builders and engineers have to care in regards to the information they plan to make use of for LLMs/GenAI interplay.

OpenAPI documentations is now accessible to obtain

The OpenAPI documentation is a specification that defines a regular approach to describe RESTful APIs, together with endpoints, parameters, request/response codecs, and authentication strategies, selling interoperability and ease of integration.

We at Cisco DevNet care about builders’ expertise and need to make your expertise working with Cisco APIs environment friendly and with minimal growth/testing prices.
You could find hyperlinks to OpenAPI documentation in JSON/YAML format right here: Open API Documentation web page and Search associated product API – Navigate to API Reference -> Overview part in left-side menu

Observe: Some API documentation can comprise a number of OpenAPI Paperwork

For which objective you should utilize associated OpenAPI documentation as part of immediate/RAG:

• Assemble code or script that makes use of associated Cisco API
• Discover associated API operations or ask to repair current code utilizing the knowledge within the API documentation
• Create integrations with Cisco merchandise by means of API
• Create and check AI brokers
• Make the most of associated Cisco OpenAPI documentation regionally or utilizing accepted AI instruments in your group.

Structured vs Unstructured information

I’ve in contrast two LLM mannequin completions with a immediate that comprises two components.
The primary a part of the immediate was the identical and contained the next info:

Based mostly on the next API documentation, please write step-by-step directions that may assist routinely tag roaming computer systems utilizing Umbrella API.
Excessive-level workflow description:

1. Add API Key
2. Generate OAuth 2.0 entry token
3. Create tag
4. Get the listing of roaming computer systems and establish associated ‘originId’
5. Add tag to units.

API documentation:

Second half:

• In a single case, it comprises copy and paste information immediately from the doc,
• The opposite one comprises LLM-friendly structured information like OpenAPI paperwork pasted one after the other

 

A part of CDO OpenAPI documentation

Claude 3 Sonnet mannequin completion. Immediate with OpenAPI paperwork 

 

Claude 3 Sonnet mannequin completion. Immediate with copy and paste information

Advantages of utilizing LLM-friendly documentation as part of the immediate

I’ve discovered that mannequin output was extra correct once we used OpenAPI paperwork as part of a immediate. API endpoints offered in every step had been extra correct. Suggestions in sections like “Get Checklist of Roaming Computer systems” comprise higher and extra optimum directions and API operations.

I’ve examined this with different foundational fashions, and mannequin completion was extra correct once I used the OpenAPI doc as part of the immediate.

Some hyperlinks on the Cisco APIs OpenAPI Paperwork

• https://developer.cisco.com/docs/cisco-defense-orchestrator/overview/
• https://developer.cisco.com/docs/cloud-security/token-overview/
• https://developer.cisco.com/docs/cisco-xdr/automation-api-guide/#sample-code

 

Share: