docu: updated Azure OpenAI SB properties

omarmahamid · Nov 7, 2024 · 671ab5c · 671ab5c
1 parent 76190c2
commit 671ab5c
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 27 deletions.
diff --git a/docs/docs/integrations/embedding-models/azure-open-ai.md b/docs/docs/integrations/embedding-models/azure-open-ai.md
@@ -43,13 +43,16 @@ EmbeddingModel model = AzureOpenAiEmbeddingModel.builder()
 ### Spring Boot
 Add to the `application.properties`:
 ```properties
+langchain4j.azure-open-ai.embedding-model.endpoint=https://langchain4j.openai.azure.com/
+langchain4j.azure-open-ai.embedding-model.service-version=...
 langchain4j.azure-open-ai.embedding-model.api-key=${AZURE_OPENAI_KEY}
 langchain4j.azure-open-ai.embedding-model.deployment-name=text-embedding-3-small
-langchain4j.azure-open-ai.embedding-model.endpoint=https://langchain4j.openai.azure.com/
-langchain4j.azure-open-ai.embedding-model.dimensions=...
-langchain4j.azure-open-ai.embedding-model.log-requests-and-responses=...
-langchain4j.azure-open-ai.embedding-model.max-retries=...
 langchain4j.azure-open-ai.embedding-model.timeout=...
+langchain4j.azure-open-ai.embedding-model.max-retries=...
+langchain4j.azure-open-ai.embedding-model.log-requests-and-responses=...
+langchain4j.azure-open-ai.embedding-model.user-agent-suffix=...
+langchain4j.azure-open-ai.embedding-model.dimensions=...
+langchain4j.azure-open-ai.embedding-model.customHeaders=...
 ```
 
 

diff --git a/docs/docs/integrations/image-models/azure-dall-e.md b/docs/docs/integrations/image-models/azure-dall-e.md
@@ -44,17 +44,20 @@ ImageModel model = AzureOpenAiImageModel.builder()
 ### Spring Boot
 Add to the `application.properties`:
 ```properties
+langchain4j.azure-open-ai.image-model.endpoint=https://langchain4j.openai.azure.com/
+langchain4j.azure-open-ai.image-model.service-version=...
 langchain4j.azure-open-ai.image-model.api-key=${AZURE_OPENAI_KEY}
 langchain4j.azure-open-ai.image-model.deployment-name=dall-e-3
-langchain4j.azure-open-ai.image-model.endpoint=https://langchain4j.openai.azure.com/
-langchain4j.azure-open-ai.image-model.log-requests-and-responses=...
-langchain4j.azure-open-ai.image-model.max-retries=...
 langchain4j.azure-open-ai.image-model.quality=...
-langchain4j.azure-open-ai.image-model.response-format=...
 langchain4j.azure-open-ai.image-model.size=...
+langchain4j.azure-open-ai.image-model.user=...
 langchain4j.azure-open-ai.image-model.style=...
+langchain4j.azure-open-ai.image-model.response-format=...
 langchain4j.azure-open-ai.image-model.timeout=...
-langchain4j.azure-open-ai.image-model.user=...
+langchain4j.azure-open-ai.image-model.max-retries=...
+langchain4j.azure-open-ai.image-model.log-requests-and-responses=...
+langchain4j.azure-open-ai.image-model.user-agent-suffix=...
+langchain4j.azure-open-ai.image-model.customHeaders=...
 ```
 
 

diff --git a/docs/docs/integrations/language-models/azure-open-ai.md b/docs/docs/integrations/language-models/azure-open-ai.md
@@ -64,21 +64,25 @@ Default model parameters can be customized by providing values in the builder.
 
 Add to the `application.properties`:
 ```properties
+langchain4j.azure-open-ai.chat-model.endpoint=https://langchain4j.openai.azure.com/
+langchain4j.azure-open-ai.chat-model.service-version=...
 langchain4j.azure-open-ai.chat-model.api-key=${AZURE_OPENAI_KEY}
+langchain4j.azure-open-ai.chat-model.non-azure-api-key=${OPENAI_API_KEY}
 langchain4j.azure-open-ai.chat-model.deployment-name=gpt-4o
-langchain4j.azure-open-ai.chat-model.endpoint=https://langchain4j.openai.azure.com/
-langchain4j.azure-open-ai.chat-model.frequency-penalty=...
-langchain4j.azure-open-ai.chat-model.log-requests-and-responses=...
-langchain4j.azure-open-ai.chat-model.max-retries=...
 langchain4j.azure-open-ai.chat-model.max-tokens=...
-langchain4j.azure-open-ai.chat-model.organization-id=...
+langchain4j.azure-open-ai.chat-model.temperature=...
+langchain4j.azure-open-ai.chat-model.top-p=
+langchain4j.azure-open-ai.chat-model.logit-bias=...
+langchain4j.azure-open-ai.chat-model.user=
+langchain4j.azure-open-ai.chat-model.stop=...
 langchain4j.azure-open-ai.chat-model.presence-penalty=...
-langchain4j.azure-open-ai.chat-model.response-format=...
+langchain4j.azure-open-ai.chat-model.frequency-penalty=...
 langchain4j.azure-open-ai.chat-model.seed=...
-langchain4j.azure-open-ai.chat-model.stop=...
-langchain4j.azure-open-ai.chat-model.temperature=...
 langchain4j.azure-open-ai.chat-model.timeout=...
-langchain4j.azure-open-ai.chat-model.top-p=
+langchain4j.azure-open-ai.chat-model.max-retries=...
+langchain4j.azure-open-ai.chat-model.log-requests-and-responses=...
+langchain4j.azure-open-ai.chat-model.user-agent-suffix=
+langchain4j.azure-open-ai.chat-model.custom-headers=...
 ```
 See the description of some of the parameters above [here](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#completions).
 
@@ -147,21 +151,24 @@ StreamingChatLanguageModel model = AzureOpenAiStreamingChatModel.builder()
 ### Spring Boot
 Add to the `application.properties`:
 ```properties
+langchain4j.azure-open-ai.streaming-chat-model.endpoint=https://langchain4j.openai.azure.com/
+langchain4j.azure-open-ai.streaming-chat-model.service-version=...
 langchain4j.azure-open-ai.streaming-chat-model.api-key=${AZURE_OPENAI_KEY}
 langchain4j.azure-open-ai.streaming-chat-model.deployment-name=gpt-4o
-langchain4j.azure-open-ai.streaming-chat-model.endpoint=https://langchain4j.openai.azure.com/
-langchain4j.azure-open-ai.streaming-chat-model.frequency-penalty=...
-langchain4j.azure-open-ai.streaming-chat-model.log-requests-and-responses=...
-langchain4j.azure-open-ai.streaming-chat-model.max-retries=...
 langchain4j.azure-open-ai.streaming-chat-model.max-tokens=...
-langchain4j.azure-open-ai.streaming-chat-model.organization-id=...
+langchain4j.azure-open-ai.streaming-chat-model.temperature=...
+langchain4j.azure-open-ai.streaming-chat-model.top-p=...
+langchain4j.azure-open-ai.streaming-chat-model.logit-bias=...
+langchain4j.azure-open-ai.streaming-chat-model.user=...
+langchain4j.azure-open-ai.streaming-chat-model.stop=...
 langchain4j.azure-open-ai.streaming-chat-model.presence-penalty=...
-langchain4j.azure-open-ai.streaming-chat-model.response-format=...
+langchain4j.azure-open-ai.streaming-chat-model.frequency-penalty=...
 langchain4j.azure-open-ai.streaming-chat-model.seed=...
-langchain4j.azure-open-ai.streaming-chat-model.stop=...
-langchain4j.azure-open-ai.streaming-chat-model.temperature=...
 langchain4j.azure-open-ai.streaming-chat-model.timeout=...
-langchain4j.azure-open-ai.streaming-chat-model.top-p=...
+langchain4j.azure-open-ai.streaming-chat-model.max-retries=...
+langchain4j.azure-open-ai.streaming-chat-model.log-requests-and-responses=...
+langchain4j.azure-open-ai.streaming-chat-model.user-agent-suffix=...
+langchain4j.azure-open-ai.streaming-chat-model.customHeaders=...
 ```