Update functions-bindings-openai-embeddingsstore-output.md

BandaruDheeraj · ggailey777 · commit 91d988102cf7 · 2024-05-20T07:41:35.000-07:00
diff --git a/articles/azure-functions/functions-bindings-openai-embeddingsstore-output.md b/articles/azure-functions/functions-bindings-openai-embeddingsstore-output.md
@@ -1,13 +1,13 @@
 ---
-title: Azure OpenAI embeddings store output binding for Azure Functions
+title: Azure OpenAI Embeddings Store Output Binding for Azure Functions
 description: Learn how to use the Azure OpenAI embeddings store output binding to write searchable content to a semantic document store during function execution in Azure Functions.
 ms.topic: reference
 ms.date: 05/08/2024
 zone_pivot_groups: programming-languages-set-functions
 ---
 <!--- Question: It seems like this binding uses Azure AI Search and not Azure OpenAI. Do we need to rename the article to:
 "Azure AI Search semantic output binding" or something like that?-->
-# Azure OpenAI embeddings store output binding for Azure Functions
+# Azure OpenAI Embeddings Store Output Binding for Azure Functions
 
 [!INCLUDE [preview-support](../../includes/functions-openai-support-limitations.md)]
 
@@ -34,24 +34,22 @@ A C# function can be created using one of the following C# modes:
 
 This example writes an HTTP input stream to a semantic document store at the provided URL. 
 
-:::code language="csharp" source="~/functions-openai-extension/samples/rag-aisearch/csharp-ooproc/FilePrompt.cs" range="31-64"::: 
+:::code language="csharp" source="~/functions-openai-extension/samples/rag-aisearch/csharp-ooproc/FilePrompt.cs" range="29-61"::: 
 
-### [In-process](#tab/in-process)
+<!-- ### [In-process](#tab/in-process)
 
-[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
+[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)] -->
 
 ---
 
 ::: zone-end  
 ::: zone pivot="programming-language-java"
-[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
-<!---uncomment when code example is available:
-{{This comes from the example code comment}} 
 
-:::code language="java" source="~/functions-openai-extension/samples/{{link to the correct sample.java}}" range="{{named is better than range}}":::
+This example writes an HTTP input stream to a semantic document store at the provided URL. 
+
+:::code language="java" source="~/functions-openai-extension/samples/rag-aisearch/java/src/main/java/com/azfs/FilePrompt.java" range="24-68":::
+
 
-{{Add more examples if available}}
--->
 ::: zone-end  
 ::: zone pivot="programming-language-javascript"
 [!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
@@ -64,40 +62,33 @@ This example writes an HTTP input stream to a semantic document store at the pro
 -->
 ::: zone-end  
 ::: zone pivot="programming-language-typescript"
-[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
-<!---uncomment when code example is available:
-{{This comes from the example code comment}} 
 
-:::code language="typescript" source="~/functions-openai-extension/samples/{{link to the correct sample.ts}}" range="{{named is better than range}}":::
+This example writes an HTTP input stream to a semantic document store at the provided URL. 
+
+:::code language="typescript" source="~/functions-openai-extension/samples/rag-aisearch/nodejs/src/app.ts" range="7-38":::
+
 
-{{Add more examples if available}}
--->
 ::: zone-end  
 ::: zone pivot="programming-language-powershell"  
-[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
-<!---uncomment when code example is available:
-{{This comes from the example code comment}} 
 
-Here's the _function.json_ file for {{example}}:
+This example writes an HTTP input stream to a semantic document store at the provided URL. 
+
+Here's the _function.json_ file for ingesting files:
 
-:::code language="json" source="~/functions-openai-extension/samples/{{link to the correct function.json}}" :::
+:::code language="json" source="~/functions-openai-extension/samples/rag-aisearch/powershell/IngestFile/function.json" :::
 
 For more information about *function.json* file properties, see the [Configuration](#configuration) section.
 
-{{This comes from the example code comment}} 
+:::code language="powershell" source="~/functions-openai-extension/samples/rag-aisearch/powershell/IngestFile/run.ps1" :::
+
 
-:::code language="powershell" source="~/functions-openai-extension/samples/{{link to the correct sample.ps1}}" :::
--->
 ::: zone-end   
 ::: zone pivot="programming-language-python"  
-[!INCLUDE [functions-examples-not-available-note](../../includes/functions-examples-not-available-note.md)]
-<!---uncomment when code example is available:
-{{This comes from the example code comment}} 
 
-:::code language="python" source="~/functions-openai-extension/samples/{{link to the correct sample.py}}" range="{{named is better than range}}":::
+This example writes an HTTP input stream to a semantic document store at the provided URL. 
+
+:::code language="python" source="~/functions-openai-extension/samples/rag-aisearch/python/function_app.py" range="8-25":::
 
-{{Add more examples if available}}
--->
 ::: zone-end  
 <!--- End code examples section -->  
 ::: zone pivot="programming-language-csharp"  
@@ -107,14 +98,13 @@ Apply the `EmbeddingsStoreOutput` attribute to define an embeddings store output
 
 | Parameter | Description |
 | --------- | ----------- |
+| **Input** | The input string for which to generate embeddings. |
+| **Model** | _Optional_. The ID of the model to use, which defaults to `text-embedding-ada-002`. You shouldn't change the model for an existing database. For more information, see [Usage](#usage). |
+| **MaxChunkLength** | _Optional_. The maximum number of characters used for chunking the input. For more information, see [Usage](#usage).|
+| **MaxOverlap** | _Optional_. Gets or sets the maximum number of characters to overlap between chunks.|
+| **InputType** | _Optional_. Gets the type of the input. |
 | **ConnectionName** | The name of an app setting or environment variable that contains the connection string value. This property supports binding expressions. |
 | **Collection** | The name of the collection or table or index to search. This property supports binding expressions.|
-| **Query** |  Gets or sets the semantic query text to use for searching. This property is only used for the semantic search input binding. This property supports binding expressions.|
-| **EmbeddingsModel** | Gets or sets the ID of the model to use for embeddings. The default value is `text-embedding-3-small`. This property supports binding expressions.|
-| **ChatModel** | Gets or sets the name of the Large Language Model to invoke for chat responses. The default value is `gpt-3.5-turbo`. This property supports binding expressions.|
-| **SystemPrompt** | _Optional_. Gets or sets the system prompt to use for prompting the large language model. The system prompt is appended with knowledge that is fetched as a result of the `Query`. The combined prompt is then sent to the OpenAI Chat API. This property supports binding expressions.|
-| **MaxKnowledgeCount** | _Optional_. Gets or sets the number of knowledge items to inject into the `SystemPrompt`.|
-
 
 ::: zone-end
 ::: zone pivot="programming-language-java"
@@ -125,14 +115,13 @@ The `EmbeddingsStoreOutput` annotation enables you to define a embeddings store
 | Element | Description |
 | ------- | ----------- |
 | **name** | Gets or sets the name of the output binding. |
+| **input** | The input string for which to generate embeddings. |
+| **model** | _Optional_. The ID of the model to use, which defaults to `text-embedding-ada-002`. You shouldn't change the model for an existing database. For more information, see [Usage](#usage). |
+| **maxChunkLength** | _Optional_. The maximum number of characters used for chunking the input. For more information, see [Usage](#usage).|
+| **maxOverlap** | _Optional_. Gets or sets the maximum number of characters to overlap between chunks.|
+| **inputType** |  _Optional_. Gets the type of the input. |
 | **connectionName** | The name of an app setting or environment variable that contains the connection string value. This property supports binding expressions. |
 | **collection** | The name of the collection or table or index to search. This property supports binding expressions.|
-| **query** |  Gets or sets the semantic query text to use for searching. This property is only used for the semantic search input binding. This property supports binding expressions.|
-| **embeddingsModel** | Gets or sets the ID of the model to use for embeddings. The default value is `text-embedding-3-small`. This property supports binding expressions.|
-| **chatModel** | Gets or sets the name of the Large Language Model to invoke for chat responses. The default value is `gpt-3.5-turbo`. This property supports binding expressions.|
-| **systemPrompt** | _Optional_. Gets or sets the system prompt to use for prompting the large language model. The system prompt is appended with knowledge that is fetched as a result of the `Query`. The combined prompt is then sent to the OpenAI Chat API. This property supports binding expressions.|
-| **maxKnowledgeCount** | _Optional_. Gets or sets the number of knowledge items to inject into the `SystemPrompt`.|
-
 
 ::: zone-end  
 ::: zone pivot="programming-language-python"  
@@ -143,13 +132,13 @@ During the preview, define the output binding as a `generic_output_binding` bind
 |Parameter | Description |
 |---------|-------------|
 | **arg_name** | The name of the variable that represents the binding parameter. |
+| **input** | The input string for which to generate embeddings. |
+| **model** | _Optional_. The ID of the model to use, which defaults to `text-embedding-ada-002`. You shouldn't change the model for an existing database. For more information, see [Usage](#usage). |
+| **maxChunkLength** | _Optional_. The maximum number of characters used for chunking the input. For more information, see [Usage](#usage).|
+| **max_overlap** | _Optional_. Gets or sets the maximum number of characters to overlap between chunks.|
+| **input_type** | Gets the type of the input. |
 | **connection_name** | The name of an app setting or environment variable that contains the connection string value. This property supports binding expressions. |
 | **collection** | The name of the collection or table or index to search. This property supports binding expressions.|
-| **query** |  Gets or sets the semantic query text to use for searching. This property is only used for the semantic search input binding. This property supports binding expressions.|
-| **embeddings_model** | Gets or sets the ID of the model to use for embeddings. The default value is `text-embedding-3-small`. This property supports binding expressions.|
-| **chat_model** | Gets or sets the name of the Large Language Model to invoke for chat responses. The default value is `gpt-3.5-turbo`. This property supports binding expressions.|
-| **system_prompt** | _Optional_. Gets or sets the system prompt to use for prompting the large language model. The system prompt is appended with knowledge that is fetched as a result of the `Query`. The combined prompt is then sent to the OpenAI Chat API. This property supports binding expressions.|
-| **max_knowledge_count** | _Optional_. Gets or sets the number of knowledge items to inject into the `SystemPrompt`.|
 
 ::: zone-end
 ::: zone pivot="programming-language-powershell"  
@@ -162,13 +151,13 @@ The binding supports these configuration properties that you set in the function
 | **type** | Must be `embeddingsStore`. |
 | **direction** | Must be `out`. |
 | **name** | The name of the output binding. |
+| **input** | The input string for which to generate embeddings. |
+| **model** | _Optional_. The ID of the model to use, which defaults to `text-embedding-ada-002`. You shouldn't change the model for an existing database. For more information, see [Usage](#usage). |
+| **maxChunkLength** | _Optional_. The maximum number of characters used for chunking the input. For more information, see [Usage](#usage).|
+| **maxOverlap** | _Optional_. Gets or sets the maximum number of characters to overlap between chunks.|
+| **inputType** | _Optional_. Gets the type of the input. |
 | **connectionName** | The name of an app setting or environment variable that contains the connection string value. This property supports binding expressions. |
 | **collection** | The name of the collection or table or index to search. This property supports binding expressions.|
-| **query** |  Gets or sets the semantic query text to use for searching. This property is only used for the semantic search input binding. This property supports binding expressions.|
-| **embeddingsModel** | Gets or sets the ID of the model to use for embeddings. The default value is `text-embedding-3-small`. This property supports binding expressions.|
-| **chatModel** | Gets or sets the name of the Large Language Model to invoke for chat responses. The default value is `gpt-3.5-turbo`. This property supports binding expressions.|
-| **systemPrompt** | _Optional_. Gets or sets the system prompt to use for prompting the large language model. The system prompt is appended with knowledge that is fetched as a result of the `Query`. The combined prompt is then sent to the OpenAI Chat API. This property supports binding expressions.|
-| **maxKnowledgeCount** | _Optional_. Gets or sets the number of knowledge items to inject into the `SystemPrompt`.|
 
 ::: zone-end  
 ::: zone pivot="programming-language-javascript,programming-language-typescript"  
@@ -178,13 +167,13 @@ The binding supports these properties, which are defined in your code:
 
 |Property | Description |
 |-----------------------|-------------|
+| **input** | The input string for which to generate embeddings. |
+| **model** | _Optional_. The ID of the model to use, which defaults to `text-embedding-ada-002`. You shouldn't change the model for an existing database. For more information, see [Usage](#usage). |
+| **maxChunkLength** | _Optional_. The maximum number of characters used for chunking the input. For more information, see [Usage](#usage).|
+| **maxOverlap** | _Optional_. Gets or sets the maximum number of characters to overlap between chunks.|
+| **inputType** | _Optional_. Gets the type of the input. |
 | **connectionName** | The name of an app setting or environment variable that contains the connection string value. This property supports binding expressions. |
 | **collection** | The name of the collection or table or index to search. This property supports binding expressions.|
-| **query** |  Gets or sets the semantic query text to use for searching. This property is only used for the semantic search input binding. This property supports binding expressions.|
-| **embeddingsModel** | Gets or sets the ID of the model to use for embeddings. The default value is `text-embedding-3-small`. This property supports binding expressions.|
-| **chatModel** | Gets or sets the name of the Large Language Model to invoke for chat responses. The default value is `gpt-3.5-turbo`. This property supports binding expressions.|
-| **systemPrompt** | _Optional_. Gets or sets the system prompt to use for prompting the large language model. The system prompt is appended with knowledge that is fetched as a result of the `Query`. The combined prompt is then sent to the OpenAI Chat API. This property supports binding expressions.|
-| **maxKnowledgeCount** | _Optional_. Gets or sets the number of knowledge items to inject into the `SystemPrompt`.|
 
 ::: zone-end  
 
