Skip to content

Commit 9eb8143

Browse files
akramakram
authored
docs: Add comprehensive Files API and Vector Store integration doc (#3279)
docs: Add comprehensive Files API and Vector Store integration documentation - Add Files API documentation with OpenAI-compatible endpoints - Create comprehensive guide for OpenAI-compatible file operations - Reorganize documentation structure: move file operations to files/ directory - Add vector store provider documentation for Milvus, SQLite-vec, FAISS - Clean up redundant files and improve navigation - Update cross-references and eliminate documentation duplication - Support for release 0.2.14 FileResponse and Vector Store API features # What does this PR do? <!-- Provide a short summary of what this PR does and why. Link to relevant issues if applicable. --> <!-- If resolving an issue, uncomment and update the line below --> <!-- Closes #[issue-number] --> ## Test Plan <!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* -->
1 parent fcf649b commit 9eb8143

File tree

11 files changed

+1747
-8
lines changed

11 files changed

+1747
-8
lines changed

‎docs/docs/api-deprecated/index.mdx‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Deprecated APIs
3+
description: Legacy APIs that are being phased out
4+
sidebar_label: Deprecated
5+
sidebar_position: 1
6+
---
7+
8+
# Deprecated APIs
9+
10+
This section contains APIs that are being phased out in favor of newer, more standardized implementations. These APIs are maintained for backward compatibility but are not recommended for new projects.
11+
12+
:::warning Deprecation Notice
13+
These APIs are deprecated and will be removed in future versions. Please migrate to the recommended alternatives listed below.
14+
:::
15+
16+
## Migration Guide
17+
18+
When using deprecated APIs, please refer to the migration guides provided for each API to understand how to transition to the supported alternatives.
19+
20+
## Deprecated API List
21+
22+
### Legacy Inference APIs
23+
Some older inference endpoints that have been superseded by the standardized Inference API.
24+
25+
**Migration Path:** Use the [Inference API](../api/) instead.
26+
27+
### Legacy Vector Operations
28+
Older vector database operations that have been replaced by the Vector IO API.
29+
30+
**Migration Path:** Use the [Vector IO API](../api/) instead.
31+
32+
### Legacy File Operations
33+
Older file management endpoints that have been replaced by the Files API.
34+
35+
**Migration Path:** Use the [Files API](../api/) instead.
36+
37+
## Support Timeline
38+
39+
Deprecated APIs will be supported according to the following timeline:
40+
41+
- **Current Version**: Full support with deprecation warnings
42+
- **Next Major Version**: Limited support with migration notices
43+
- **Following Major Version**: Removal of deprecated APIs
44+
45+
## Getting Help
46+
47+
If you need assistance migrating from deprecated APIs:
48+
49+
1. Check the specific migration guides for each API
50+
2. Review the [API Reference](../api/) for current alternatives
51+
3. Consult the [Community Forums](https://github.com/llamastack/llama-stack/discussions) for migration support
52+
4. Open an issue on GitHub for specific migration questions
53+
54+
## Contributing
55+
56+
If you find issues with deprecated APIs or have suggestions for improving the migration process, please contribute by:
57+
58+
1. Opening an issue describing the problem
59+
2. Submitting a pull request with improvements
60+
3. Updating migration documentation
61+
62+
For more information on contributing, see our [Contributing Guide](../contributing/).

‎docs/docs/api-experimental/index.mdx‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
title: Experimental APIs
3+
description: APIs in development with limited support
4+
sidebar_label: Experimental
5+
sidebar_position: 1
6+
---
7+
8+
# Experimental APIs
9+
10+
This section contains APIs that are currently in development and may have limited support or stability. These APIs are available for testing and feedback but should not be used in production environments.
11+
12+
:::warning Experimental Notice
13+
These APIs are experimental and may change without notice. Use with caution and provide feedback to help improve them.
14+
:::
15+
16+
## Current Experimental APIs
17+
18+
### Batch Inference API
19+
Run inference on a dataset of inputs in batch mode for improved efficiency.
20+
21+
**Status:** In Development
22+
**Provider Support:** Limited
23+
**Use Case:** Large-scale inference operations
24+
25+
**Features:**
26+
- Batch processing of multiple inputs
27+
- Optimized resource utilization
28+
- Progress tracking and monitoring
29+
30+
### Batch Agents API
31+
Run agentic workflows on a dataset of inputs in batch mode.
32+
33+
**Status:** In Development
34+
**Provider Support:** Limited
35+
**Use Case:** Large-scale agent operations
36+
37+
**Features:**
38+
- Batch agent execution
39+
- Parallel processing capabilities
40+
- Result aggregation and analysis
41+
42+
### Synthetic Data Generation API
43+
Generate synthetic data for model development and testing.
44+
45+
**Status:** Early Development
46+
**Provider Support:** Very Limited
47+
**Use Case:** Training data augmentation
48+
49+
**Features:**
50+
- Automated data generation
51+
- Quality control mechanisms
52+
- Customizable generation parameters
53+
54+
### Batches API (OpenAI-compatible)
55+
OpenAI-compatible batch management for inference operations.
56+
57+
**Status:** In Development
58+
**Provider Support:** Limited
59+
**Use Case:** OpenAI batch processing compatibility
60+
61+
**Features:**
62+
- OpenAI batch API compatibility
63+
- Job scheduling and management
64+
- Status tracking and monitoring
65+
66+
## Getting Started with Experimental APIs
67+
68+
### Prerequisites
69+
- Llama Stack server running with experimental features enabled
70+
- Appropriate provider configurations
71+
- Understanding of API limitations
72+
73+
### Configuration
74+
Experimental APIs may require special configuration flags or provider settings. Check the specific API documentation for setup requirements.
75+
76+
### Usage Guidelines
77+
1. **Testing Only**: Use experimental APIs for testing and development only
78+
2. **Monitor Changes**: Watch for updates and breaking changes
79+
3. **Provide Feedback**: Report issues and suggest improvements
80+
4. **Backup Data**: Always backup important data when using experimental features
81+
82+
## Feedback and Contribution
83+
84+
We encourage feedback on experimental APIs to help improve them:
85+
86+
### Reporting Issues
87+
- Use GitHub issues with the "experimental" label
88+
- Include detailed error messages and reproduction steps
89+
- Specify the API version and provider being used
90+
91+
### Feature Requests
92+
- Submit feature requests through GitHub discussions
93+
- Provide use cases and expected behavior
94+
- Consider contributing implementations
95+
96+
### Testing
97+
- Test experimental APIs in your environment
98+
- Report performance issues and optimization opportunities
99+
- Share success stories and use cases
100+
101+
## Migration to Stable APIs
102+
103+
As experimental APIs mature, they will be moved to the stable API section. When this happens:
104+
105+
1. **Announcement**: We'll announce the promotion in release notes
106+
2. **Migration Guide**: Detailed migration instructions will be provided
107+
3. **Deprecation Timeline**: Experimental versions will be deprecated with notice
108+
4. **Support**: Full support will be available for stable versions
109+
110+
## Provider Support
111+
112+
Experimental APIs may have limited provider support. Check the specific API documentation for:
113+
114+
- Supported providers
115+
- Configuration requirements
116+
- Known limitations
117+
- Performance characteristics
118+
119+
## Roadmap
120+
121+
Experimental APIs are part of our ongoing development roadmap:
122+
123+
- **Q1 2024**: Batch Inference API stabilization
124+
- **Q2 2024**: Batch Agents API improvements
125+
- **Q3 2024**: Synthetic Data Generation API expansion
126+
- **Q4 2024**: Batches API full OpenAI compatibility
127+
128+
For the latest updates, follow our [GitHub releases](https://github.com/llamastack/llama-stack/releases) and [roadmap discussions](https://github.com/llamastack/llama-stack/discussions).

0 commit comments

Comments
 (0)