azure-search-documents-py

Build, index, and query vector-aware search experiences with the Azure AI Search SDK for Python.

2.9k|323|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/microsoft/skills --skill azure-search-documents-py-microsoft
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: azure-search-documents-py
Source: https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-python/skills/azure-search-documents-py
Command: npx skills add https://github.com/microsoft/skills --skill azure-search-documents-py-microsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires azure-identity, azure-search-documents, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Azure AI Search SDK for Python enables developers to incorporate powerful search capabilities into Python applications, including vector search, semantic ranking, and seamless integration with Azure OpenAI services.

Core Features & Use Cases

  • Client libraries for common tasks: SearchClient, SearchIndexClient, and related adapters to manage indices, documents, and knowledge sources.
  • Vector search and semantic ranking: configure vector fields, HNSW algorithms, and semantic configurations to improve relevance.
  • Knowledge base integration: connect knowledge sources and knowledge bases to enable agentic retrieval and Q&A workflows with LLMs.

Quick Start

Install the Azure AI Search Python SDK and run a minimal example to create a client and perform a simple search.

Frequently Asked Questions about azure-search-documents-py

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure vector search and semantic ranking in Python for Azure AI Search?

Vector search and semantic ranking in Azure AI Search are configured in Python by defining vector fields, HNSW algorithms, and semantic configurations through the SearchClient and SearchIndexClient libraries to improve query relevance.

How do I build a knowledge base with Azure OpenAI using the Azure Search Python SDK?

Building a knowledge base with Azure OpenAI involves using the AzureOpenAIVectorizer for integrated vectorization, connecting knowledge sources through the Python SDK to enable agentic retrieval and Q&A workflows with LLMs.

Can I manage Azure AI Search indices and documents programmatically in Python?

Managing Azure AI Search indices and documents programmatically in Python is supported through client libraries like SearchClient and SearchIndexClient, which handle index creation, document management, and knowledge source connections.

Do I need Azure Identity to authenticate Azure AI Search clients in Python?

Azure Identity is required to authenticate Azure AI Search clients in Python, providing authentication patterns that securely connect Python applications to Azure OpenAI deployments and search services.

What is the best way to integrate vector-aware search experiences into a Python application?

Integrating vector-aware search experiences into a Python application is best achieved using the Azure AI Search SDK, which covers client creation, index management, vector search configuration, and semantic ranking end-to-end.

Why does my Azure AI Search semantic configuration not improve search relevance in Python?

Azure AI Search semantic configuration requires proper setup of semantic ranking configurations and vector fields through the Python SDK; misconfigured HNSW algorithms or missing AzureOpenAIVectorizer integrated vectorization can limit relevance improvements.