Skip to content

functions-bindings-openai-assistantcreate-output.md

Latest commit

 

History

History
156 lines (117 loc) · 8.01 KB

functions-bindings-openai-assistantcreate-output.md

File metadata and controls

156 lines (117 loc) · 8.01 KB
title Azure OpenAI assistant create output binding for Azure Functions
description Learn how to use the Azure OpenAI assistant create output binding to create Azure OpenAI assistants from your function code executions.
ms.topic reference
ms.custom
build-2024
devx-track-extended-java
devx-track-js
devx-track-python
devx-track-ts
build-2025
ms.collection
ce-skilling-ai-copilot
ms.date 05/15/2025
ms.update-cycle 180-days
zone_pivot_groups programming-languages-set-functions

Azure OpenAI assistant create output binding for Azure Functions

[!INCLUDE preview-support]

The Azure OpenAI assistant create output binding allows you to create a new assistant chat bot from your function code execution.

For information on setup and configuration details of the Azure OpenAI extension, see Azure OpenAI extensions for Azure Functions. To learn more about Azure OpenAI assistants, see Azure OpenAI Assistants API.

[!INCLUDE functions-support-notes-samples-openai]

Example

::: zone pivot="programming-language-csharp"
This example demonstrates the creation process, where the HTTP PUT function that creates a new assistant chat bot with the specified ID. The response to the prompt is returned in the HTTP response.

:::code language="csharp" source="~/functions-openai-extension/samples/assistant/csharp-ooproc/AssistantApis.cs" range="19-56":::

::: zone-end
::: zone pivot="programming-language-java" This example demonstrates the creation process, where the HTTP PUT function that creates a new assistant chat bot with the specified ID. The response to the prompt is returned in the HTTP response.

:::code language="java" source="~/functions-openai-extension/samples/assistant/java/src/main/java/com/azfs/AssistantApis.java" range="30-77":::

::: zone-end
::: zone pivot="programming-language-javascript,programming-language-typescript"
This example demonstrates the creation process, where the HTTP PUT function that creates a new assistant chat bot with the specified ID. The response to the prompt is returned in the HTTP response.
::: zone-end
::: zone pivot="programming-language-javascript"

:::code language="javascript" source="~/functions-openai-extension/samples/assistant/javascript/src/functions/assistantApis.js" range="4-33" :::

::: zone-end ::: zone pivot="programming-language-typescript"

:::code language="typescript" source="~/functions-openai-extension/samples/assistant/typescript/src/functions/assistantApis.ts" range="4-33" :::

::: zone-end
::: zone pivot="programming-language-powershell"
This example demonstrates the creation process, where the HTTP PUT function that creates a new assistant chat bot with the specified ID. The response to the prompt is returned in the HTTP response.

Here's the function.json file for Create Assistant:

:::code language="json" source="~/functions-openai-extension/samples/assistant/powershell/CreateAssistant/function.json" :::

For more information about function.json file properties, see the Configuration section.

{{This comes from the example code comment}} :::code language="powershell" source="~/functions-openai-extension/samples/assistant/powershell/CreateAssistant/run.ps1" :::

::: zone-end
::: zone pivot="programming-language-python"
This example demonstrates the creation process, where the HTTP PUT function that creates a new assistant chat bot with the specified ID. The response to the prompt is returned in the HTTP response.

:::code language="python" source="~/functions-openai-extension/samples/assistant/python/assistant_apis.py" range="6-31" :::

::: zone-end

::: zone pivot="programming-language-csharp"

Attributes

Apply the CreateAssistant attribute to define an assistant create output binding, which supports these parameters:

Parameter Description
Id The identifier of the assistant to create.
Instructions Optional. The instructions that are provided to assistant to follow.
ChatStorageConnectionSetting Optional. The configuration section name for the table settings for chat storage. The default value is AzureWebJobsStorage.
CollectionName Optional. The table collection name for chat storage. The default value is ChatState.

::: zone-end ::: zone pivot="programming-language-java"

Annotations

The CreateAssistant annotation enables you to define an assistant create output binding, which supports these parameters:

Element Description
name Gets or sets the name of the output binding.
id The identifier of the assistant to create.
instructions Optional. The instructions that are provided to assistant to follow.
chatStorageConnectionSetting Optional. The configuration section name for the table settings for chat storage. The default value is AzureWebJobsStorage.
collectionName Optional. The table collection name for chat storage. The default value is ChatState.

::: zone-end
::: zone pivot="programming-language-python"

Decorators

During the preview, define the output binding as a generic_output_binding binding of type createAssistant, which supports these parameters:

Parameter Description
arg_name The name of the variable that represents the binding parameter.
id The identifier of the assistant to create.
instructions Optional. The instructions that are provided to assistant to follow.
chat_storage_connection_setting Optional. The configuration section name for the table settings for chat storage. The default value is AzureWebJobsStorage.
collection_name Optional. The table collection name for chat storage. The default value is ChatState.

::: zone-end ::: zone pivot="programming-language-powershell"

Configuration

The binding supports these configuration properties that you set in the function.json file.

Property Description
type Must be CreateAssistant.
direction Must be out.
name The name of the output binding.
id The identifier of the assistant to create.
instructions Optional. The instructions that are provided to assistant to follow.
chatStorageConnectionSetting Optional. The configuration section name for the table settings for chat storage. The default value is AzureWebJobsStorage.
collectionName Optional. The table collection name for chat storage. The default value is ChatState.

::: zone-end
::: zone pivot="programming-language-javascript,programming-language-typescript"

Configuration

The binding supports these properties, which are defined in your code:

Property Description
id The identifier of the assistant to create.
instructions Optional. The instructions that are provided to assistant to follow.
chatStorageConnectionSetting Optional. The configuration section name for the table settings for chat storage. The default value is AzureWebJobsStorage.
collectionName Optional. The table collection name for chat storage. The default value is ChatState.
::: zone-end

Usage

See the Example section for complete examples.

Related content