REST samples for Foundry IQ (Azure AI Search)

Note

Foundry IQ (Azure AI Search) provides direct indexing and query APIs alongside higher-level knowledge source and knowledge base APIs for managed retrieval. Use the Azure portal, REST APIs, or Azure SDKs to configure these capabilities, or connect agents to knowledge bases in the Microsoft Foundry portal.

Learn about REST API samples that demonstrate the functionality and workflow of a Foundry IQ (Azure AI Search) solution. These samples use the Search Service REST APIs.

REST is the definitive programming interface for Foundry IQ, offering a language-agnostic way to interact with the service. For this reason, most examples in our documentation use the REST APIs to demonstrate and explain important concepts.

You can use any client that supports HTTP calls. To learn how to formulate the HTTP request using Visual Studio Code with the REST Client extension, see the REST portion of Quickstart: Full-text search.

Doc samples

Code samples from the Foundry IQ team demonstrate features and workflows. The following samples are referenced in tutorials, quickstarts, and how-to articles. You can find these samples in Azure-Samples/azure-search-rest-samples on GitHub.

Sample Article Description
quickstart-agentic-retrieval Quickstart: Agentic retrieval Integrate semantic ranking with LLM-powered query planning and answer generation.
quickstart-keyword-search Quickstart: Full-text search Create, load, and query a search index using sample data.
quickstart-semantic-ranking Quickstart: Semantic ranking Add semantic ranking to an index schema and run semantic queries.
quickstart-vectors Quickstart: Vector search Index and query vector content.
acl Query-time ACL and RBAC enforcement Implement query-time access control by using role-based access control (RBAC) and access control lists (ACLs). Check the sample's API version and source-specific availability.
custom-analyzers Tutorial: Create a custom analyzer for phone numbers Use an analyzer to preserve patterns and special characters in searchable content.
debug-sessions Tutorial: Fix a skillset using Debug Sessions Create search objects that you later debug in the Azure portal.
index-json-blobs Tutorial: Index JSON blobs from Azure Storage Create an indexer, data source, and index for nested JSON within a JSON array. Demonstrates the jsonArray parsing model and documentRoot parameters.
knowledge-store Create a knowledge store using REST Populate a knowledge store for knowledge mining workflows.
projections Define projections in a knowledge store Specify the physical data structures in a knowledge store.
skillset-tutorial Tutorial: AI-generated searchable content from Azure blobs Create a skillset that iterates over Azure blobs to extract information and infer structure.

Other samples

The following samples are also published by the Foundry IQ team but aren't referenced in documentation. Associated README files provide usage instructions.

Sample Description
azure-search-classic-rag Single-shot RAG using the classic search engine as grounding data from Foundry IQ, with a chat completion model from Azure OpenAI.

Tip

Use the samples browser to search for Microsoft code samples on GitHub. You can filter your search by product, service, and language.