共用方式為


適用於 Azure AI 搜尋服務的 Python 範例

瞭解示範 Azure AI 搜尋服務解決方案功能和工作流程的 Python 程式碼範例。 這些範例會使用 Azure SDK for Python 的 Azure AI 搜尋服務用戶端程式庫,您可以透過下列連結來進行探索。

Target Link
套件下載 pypi.org/project/azure-search-documents/
API 參考資料 azure-search-documents
API 測試案例 github.com/Azure/azure-sdk-for-python/tree/main/sdk/search/azure-search-documents/tests
原始程式碼 github.com/Azure/azure-sdk-for-python/tree/main/sdk/search/azure-search-documents
變更紀錄 github.com/Azure/azure-sdk-for-python/blob/main/sdk/search/azure-search-documents/CHANGELOG.md

SDK 範例

Azure SDK 開發小組示範 API 使用方式的程式碼範例。 您可以在 GitHub 上的 Azure/azure-sdk-for-python/tree/main/sdk/search/azure-search-documents/samples 中找到這些範例。

文件範例

來自 Azure AI 搜尋服務小組的程式碼範例會示範功能和工作流程。 教學課程、快速入門和操作說明文章中會參考下列範例。 您可以在 GitHub 上的 Azure-Samples/azure-search-python-samples 中找到這些範例。

範例 發行項 Description
Quickstart 快速入門:全文搜索 使用範例資料建立、載入及查詢搜尋索引。
Quickstart-Agentic-Retrieval 快速入門:代理程式擷取 將語義排名與 LLM 驅動的查詢規劃和答案生成整合。
Quickstart-RAG 快速入門:Generative search (RAG) 將 Azure AI 搜尋服務的基礎資料與 Azure OpenAI 的聊天完成模型搭配使用。
Quickstart-Semantic-Search 快速入門:語意排名 將語意排名新增至索引結構描述,並執行語意查詢。
Quickstart-Vector-Search 快速入門:向量搜尋 索引和查詢向量資料。
agentic-retrieval-pipeline-example 教學:建立端對端代理檢索解決方案 Quickstart-Agentic-Retrieval 不同,此範例整合了 Foundry Agent Service 用於請求協調。

Accelerators

加速器是一種端對端解決方案,其中包含程式碼和文件,您可以根據自己實作特定案例進行調整。

範例 Description
rag-experiment-accelerator 使用 Azure AI 搜尋和 RAG 模式進行實驗和評估。 此範例包含載入多個資料來源、使用各種模型,以及建立各種搜尋索引和查詢的程式碼。

Demos

示範存放庫會為示範中顯示的範例或案例,提供概念證明原始程式碼。 與加速器不同,示範解決方案並非專為適應而設計。

範例 Description
azure-search-vector-samples 向量搜尋案例的範例完整集合,依案例或技術組織。
azure-search-openai-demo 類似 ChatGPT 的企業數據體驗使用 Azure OpenAI Python 程式碼,示範如何在 Azure OpenAI 中搭配大型語言模型使用 Azure AI 搜尋服務。 有關背景信息,請參閱此 博客文章
aisearch-openai-rag-audio “對 RAG 發聲。”此範例示範語音型生成式 AI 應用程式的簡單架構,可在即時音訊 API 之上啟用 Azure AI 搜尋服務 RAG,並從用戶端裝置進行全雙工音訊串流。 它還安全地處理對模型和檢索系統的訪問。 後端程序代碼是以 Python 撰寫,而前端程式代碼則以 JavaScript 撰寫。 如需簡介,請觀看這段 影片

其他範例

下列範例也會由 Azure AI 搜尋小組發佈,但不會在文件中參考。 相關聯的 README 檔案提供使用指示。

範例 Description
經典 RAG 模式 建立一個索引流程,利用 傳統搜尋引擎 來載入、分塊、嵌入並吸收可搜尋內容。
Quickstart-Document-Permissions-Pull-API 利用索引器「API 拉取」方法,將存取控制清單從資料來源端傳送到搜尋結果端,並套用權限過濾器以限制對授權內容的存取。
Quickstart-Document-Permissions-Push-API 透過使用推送 API 來對 JSON 承載進行索引編製,將內嵌的權限中繼資料流向到已編製索引的文件,以及基於使用者對授權內容的存取權限進行篩選的搜尋結果。
azure-function-search 使用 Azure 函式將查詢傳送至搜尋服務。 您可以將此 Python 版本替換為 api 程式碼,此程式碼在 使用 .NET 將搜尋功能新增至網站中使用。
bulk-insert 使用推播 API 來上傳和索引文件。
index-backup-and-restore.ipynb 在索引中建立可擷取欄位的本機副本,並將這些欄位推送至新索引。
resumable-index-backup-restore 備份和還原超過 100,000 個文件的較大索引。

Tip

使用 範例瀏覽器 在 GitHub 上搜尋 Microsoft 程式碼範例。 您可以按產品、服務和語言過濾搜索。