From 03350335cdb184e7e122c01359f292e037b08b13 Mon Sep 17 00:00:00 2001 From: Jack Ryan <61809814+jackaldenryan@users.noreply.github.com> Date: Thu, 28 Aug 2025 11:09:54 -0500 Subject: [PATCH] docs: Add Azure OpenAI v1 API opt-in requirement documentation (#873) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add important notice about Azure OpenAI v1 API opt-in requirement for structured outputs. Without this opt-in, users encounter 404 errors when using client.beta.chat.completions.parse(). Includes link to Microsoft's official documentation on the v1 API migration. Fixes ZEPAI-1634 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index db09e137..23b765de 100644 --- a/README.md +++ b/README.md @@ -337,6 +337,13 @@ as such this feature is off by default. Graphiti supports Azure OpenAI for both LLM inference and embeddings. Azure deployments often require different endpoints for LLM and embedding services, and separate deployments for default and small models. +> [!IMPORTANT] +> **Azure OpenAI v1 API Opt-in Required for Structured Outputs** +> +> Graphiti uses structured outputs via the `client.beta.chat.completions.parse()` method, which requires Azure OpenAI deployments to opt into the v1 API. Without this opt-in, you'll encounter 404 Resource not found errors during episode ingestion. +> +> To enable v1 API support in your Azure OpenAI deployment, follow Microsoft's guide: [Azure OpenAI API version lifecycle](https://learn.microsoft.com/en-us/azure/ai-foundry/openai/api-version-lifecycle?tabs=key#api-evolution). + ```python from openai import AsyncAzureOpenAI from graphiti_core import Graphiti