Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
The Azure OpenAI extension for Azure Functions is currently in preview.
The Azure OpenAI assistant trigger lets you run your code based on custom chat bot or skill request made to an assistant.
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.
Note
References and examples are only provided for the Node.js v4 model.
Note
References and examples are only provided for the Python v2 model.
Note
While both C# process models are supported, only isolated worker model examples are provided.
Example
Go support isn't currently available for this binding.
This example demonstrates how to create an assistant that adds a new todo task to a database. The trigger has a static description of Create a new todo task used by the model. The function itself takes a string, which represents a new task to add. When executed, the function adds the task as a new todo item in a custom item store and returns a response from the store.
This example demonstrates how to create an assistant that adds a new todo task to a database. The trigger has a static description of Create a new todo task used by the model. The function itself takes a string, which represents a new task to add. When executed, the function adds the task as a new todo item in a custom item store and returns a response from the store.
This example demonstrates how to create an assistant that adds a new todo task to a database. The trigger has a static description of Create a new todo task used by the model. The function itself takes a string, which represents a new task to add. When executed, the function adds the task as a new todo item in a custom item store and returns a response from the store.
This example demonstrates how to create an assistant that adds a new todo task to a database. The trigger has a static description of Create a new todo task used by the model. The function itself takes a string, which represents a new task to add. When executed, the function adds the task as a new todo item in a custom item store and returns a response from the store.
Here's the function.json file for Add Todo:
For more information about function.json file properties, see the Configuration section.
This example demonstrates how to create an assistant that adds a new todo task to a database. The trigger has a static description of Create a new todo task used by the model. The function itself takes a string, which represents a new task to add. When executed, the function adds the task as a new todo item in a custom item store and returns a response from the store.
Attributes
Apply the AssistantSkillTrigger attribute to define an assistant trigger, which supports these parameters:
| Parameter | Description |
|---|---|
| FunctionDescription | Gets the description of the assistant function, which is provided to the model. |
| FunctionName | Optional. Gets or sets the name of the function called by the assistant. |
| ParameterDescriptionJson | Optional. Gets or sets a JSON description of the function parameter, which is provided to the model. For more information, see Usage. |
Annotations
The AssistantSkillTrigger annotation enables you to define an assistant trigger, which supports these parameters:
| Element | Description |
|---|---|
| name | Gets or sets the name of the input binding. |
| functionDescription | Gets the description of the assistant function, which is provided to the model. |
| functionName | Optional. Gets or sets the name of the function called by the assistant. |
| parameterDescriptionJson | Optional. Gets or sets a JSON description of the function parameter, which is provided to the model. For more information, see Usage. |
Decorators
During the preview, define the input binding as a generic_trigger binding of type assistantSkillTrigger, which supports these parameters:
| Parameter | Description |
|---|---|
| function_description | Gets the description of the assistant function, which is provided to the model. |
| function_name | Optional. Gets or sets the name of a function called by the assistant. |
| parameterDescriptionJson | Optional. Gets or sets a JSON description of the function parameter, which is provided to the model. For more information, see Usage. |
Configuration
The binding supports these configuration properties that you set in the function.json file.
| Property | Description |
|---|---|
| type | Must be AssistantSkillTrigger. |
| direction | Must be in. |
| name | The name of the trigger. |
| functionName | Gets or sets the name of the function called by the assistant. |
| functionDescription | Gets the description of the assistant function, which is provided to the language model. |
| parameterDescriptionJson | Optional. Gets or sets a JSON description of the function parameter, which is provided to the model. For more information, see Usage. |
Configuration
The binding supports these properties, which are defined in your code:
| Property | Description |
|---|---|
| type | Must be AssistantSkillTrigger. |
| name | The name of the trigger. |
| functionName | Gets or sets the name of the function called by the assistant. |
| functionDescription | Gets the description of the assistant function, which is provided to the LLM |
| parameterDescriptionJson | Optional. Gets or sets a JSON description of the function parameter, which is provided to the model. For more information, see Usage. |
See the Example section for complete examples.
Usage
When parameterDescriptionJson JSON value isn't provided, it's autogenerated. For more information on the syntax of this object, see the OpenAI function calling documentation.