# Ducky Documentation

> Documentation for Ducky

## Guides
- [Getting Started](https://docs.ducky.ai/docs/getting-started.md): Learn the basics of retrieval with Ducky
- [Using SDKs and API](https://docs.ducky.ai/docs/sdk-guide.md): Complete guide to Python SDK, TypeScript SDK, and direct API usage
- [Understanding Indexes](https://docs.ducky.ai/docs/understanding-indexes.md): What indexes are and how to organize your content effectively
- [Document Chunks](https://docs.ducky.ai/docs/document-chunks.md): Understanding how Ducky breaks documents into searchable chunks
- [Working with Files](https://docs.ducky.ai/docs/working-with-files.md): How to upload and index PDF files and text documents
- [Multimodal Indexing](https://docs.ducky.ai/docs/multimodal-indexing.md): Index and search images with text content using multimodal capabilities
- [Ask Your Documents](https://docs.ducky.ai/docs/ask-endpoint.md): Get direct answers to questions using Ducky's intelligent ask endpoint
- [Core concepts](https://docs.ducky.ai/docs/core-concepts.md): High-level concepts in Ducky and how they relate to each other
- [Authentication and setup](https://docs.ducky.ai/docs/authentication-and-setup.md): Ducky uses API key-based authentication
- [Alpha Parameter](https://docs.ducky.ai/docs/alpha-parameter.md): Understanding the alpha parameter for search balance
- [How to load data into Ducky](https://docs.ducky.ai/docs/how-to-load-data-into-ducky.md): Upload your documents into Ducky's indexes
- [How retrieval works](https://docs.ducky.ai/docs/how-retrieval-works.md): This guide explains Ducky's retrieval process, covering data preparation, search, and result refinement.
- [Balancing keyword and semantic search](https://docs.ducky.ai/docs/balancing-keyword-and-semantic-search.md): Modify the alpha value to control the balance
- [Frequently asked questions](https://docs.ducky.ai/docs/faq.md)
- [Document Scores](https://docs.ducky.ai/docs/document-scores.md): Understanding relevance scores in search results
- [Document Upserts](https://docs.ducky.ai/docs/document-upserts.md): How to update existing documents with upsert operations
- [Asynchronous Operations](https://docs.ducky.ai/docs/async-operations.md): Understanding async processing for indexing, deletion, and file uploads
- [Advanced Metadata Usage](https://docs.ducky.ai/docs/advanced-metadata.md): Master complex filtering, data types, and metadata best practices

## API Reference
- [List indexes within a project](https://docs.ducky.ai/reference/listindexes.md): Retrieve a list of all created indexes.
- [Create an index](https://docs.ducky.ai/reference/createindex.md): Create a new index to organize and store documents or items from integrations.
- [Delete an index](https://docs.ducky.ai/reference/deleteindex.md): Delete a specific index by providing its unique identifier.
- [Get an index](https://docs.ducky.ai/reference/getindex.md): Get the details of an index by index name.
- [Ask a question to an index](https://docs.ducky.ai/reference/askindex.md): Ask a natural language question and get a synthesized answer from documents in the index
- [List documents within an index](https://docs.ducky.ai/reference/listdocuments.md): Retrieve a list of all documents.
- [Batch index text documents](https://docs.ducky.ai/reference/batchindextext.md): Batch index text documents. Limited to 100 documents per batch.
- [Index a document by uploading a file](https://docs.ducky.ai/reference/indexfile.md): Index a document into the specified index by uploading a file. Supports UTF-8 encoded text-based files and PDF files. The file size must be less than 60MB.
- [Index a document from an image and text content](https://docs.ducky.ai/reference/indexmultimodal.md): Index a document into the specified index by providing the image and text content as a JSON object.
- [Index a document from text content](https://docs.ducky.ai/reference/indextext.md): Index a document into the specified index by providing the content as a JSON object.
- [Retrieve documents from an index](https://docs.ducky.ai/reference/retrievedocuments.md): Retrieve documents from an index using a query, top_k, and other parameters
- [Delete a document](https://docs.ducky.ai/reference/deletedocument.md): Delete a specific document by providing its unique identifier.
- [Get a document by ID with pagination](https://docs.ducky.ai/reference/getdocument.md): Retrieve a specific document by providing the document ID, supporting pagination for large documents with multiple chunks.