Valyu Best Practices

What it does

This skill provides guidance and instructions for effectively using the ValyuAI API to perform various data retrieval and analysis tasks. It covers a range of functionalities including searching across diverse sources, extracting content from specific URLs, generating AI-powered answers with citations, creating comprehensive research reports, and discovering available data sources. Crucially, it emphasizes the use of official SDK libraries for optimal performance and reliability.

When to use it

• Researching current events: Quickly find up-to-date information on any topic using the Search API.
• Academic exploration: Conduct research utilizing academic databases like arXiv and PubMed with the Search API.
• Financial analysis: Access financial data such as SEC filings and stock reports through the Search API.
• Healthcare insights: Retrieve clinical trial data or drug labels using the Search API.
• Generating in-depth reports: Create comprehensive research reports leveraging the DeepResearch API.

Key capabilities

• Provides a decision tree to select the appropriate Valyu API (Search, Contents, Answer, DeepResearch, Datasources).
• Mandates the use of official SDK libraries (valyu-js for JavaScript/TypeScript and valyu for Python) instead of raw HTTP calls.
• Offers type safety with TypeScript/Python type hints.
• Includes automatic retry logic for handling transient failures.
• Supports streaming responses via async iterators.
• Provides structured error handling with helpful messages.

Example prompts

• "Use the Valyu Search API to find recent articles on transformer architectures and attention mechanisms."
• "Generate a research report using the DeepResearch API about the impact of AI on the financial markets."
• "Extract content from this URL: [URL] using the Contents API."

Tips & gotchas

• SDK is mandatory: Always use the official valyu-js or valyu SDK libraries. Avoid making direct HTTP requests to the Valyu API endpoints.
• API Key Required: You'll need a VALYU_API_KEY environment variable set up for authentication.
• Explore Search Types: The Search API offers different search types (e.g., "all") which can be used to refine your results.