Skip to main content

Type

knowledge_api

Technology

Vector Search & Embeddings
Purpose: The Knowledge API skill enables agents to perform semantic search across your organization’s knowledge base using natural language, finding relevant information from documentation, policies, tickets, and more.

Common Use Cases

Searching documentationFind relevant guides, API docs, runbooks, and technical documentation

Finding relevant policiesDiscover compliance requirements, security policies, and procedures

Discovering similar issuesFind past tickets, incidents, and resolutions for similar problems

Context-aware retrievalRetrieve information based on meaning, not just keywords

How It Works

1

Content Ingestion

Knowledge sources are indexed: documentation sites, code repositories, ticketing systems, communication archives
2

Embedding Generation

Text is converted to vector embeddings that capture semantic meaning
3

Semantic Search

Queries are converted to embeddings, matched with similar content, and ranked by relevance
4

Reranking (Optional)

Results can be reranked using advanced models for better accuracy

Configuration

Example Configuration:

Quick Start

View Complete Examples

See full search patterns, incident response queries, and policy compliance examples

Query Examples

Technical Documentation

Query:
Results:

Past Incidents

Query:
Results:

Policy Compliance

Query:
Results:

Security Best Practices

Limit knowledge_sources to only necessary sources.
Use appropriate similarity_threshold to ensure quality results.
Use metadata filters to exclude sensitive or restricted content.
Best Practice: Enable reranking for customer-facing agents to ensure the most accurate results.

Solutions:
  • Lower similarity_threshold value
  • Check knowledge sources are indexed and syncing
  • Verify query isn’t too specific
Solutions:
  • Increase similarity_threshold for higher quality
  • Enable reranking for better relevance
  • Use more specific query phrasing
Solutions:
  • Reduce max_results value
  • Disable reranking if not needed
  • Limit knowledge_sources to fewer sources

Contextual Awareness

Query structured data in context graph

Agent Communication

Delegate to knowledge-specific agents

Python Skill

Process and analyze search results

View All Skills

Return to built-in skills overview