La liaison de création de sortie de l’assistant Azure OpenAI pour Azure Functions

Important

L’extension Azure OpenAI pour Azure Functions est actuellement en préversion.

La liaison de création de sortie de l’assistant Azure OpenAI vous permet de créer un bot de conversation assistant à partir de l’exécution de votre code de fonction.

Pour plus d’informations sur l’installation et la configuration de l’extension Azure OpenAI, consultez Extensions Azure OpenAI pour Azure Functions. Si vous souhaitez en savoir plus sur les assistants Azure OpenAI, veuillez consulter la rubrique API d’assistants Azure OpenAI.

Remarque

Les références et les exemples sont fournis uniquement pour le modèle Node.js v4.

Remarque

Les références et exemples sont fournis uniquement pour le modèle Python v2.

Remarque

Bien que les deux modèles de processus C# soient pris en charge, seuls les exemples de modèles worker isolés sont fournis.

Exemple

Le support Go n’est pas disponible pour ce liaison pour le moment.

Cet exemple illustre le processus de création, où la fonction HTTP PUT qui crée un bot de conversation assistant avec l’ID spécifié. La réponse à l’invite est renvoyée dans la réponse HTTP.

/// <summary>
/// HTTP PUT function that creates a new assistant chat bot with the specified ID.
/// </summary>
[Function(nameof(CreateAssistant))]
public static async Task<CreateChatBotOutput> CreateAssistant(
    [HttpTrigger(AuthorizationLevel.Function, "put", Route = "assistants/{assistantId}")] HttpRequestData req,
    string assistantId)
{
    string instructions =
       """
        Don't make assumptions about what values to plug into functions.
        Ask for clarification if a user request is ambiguous.
        """;

    using StreamReader reader = new(req.Body);

    string request = await reader.ReadToEndAsync();


    return new CreateChatBotOutput
    {
        HttpResponse = new ObjectResult(new { assistantId }) { StatusCode = 201 },
        ChatBotCreateRequest = new AssistantCreateRequest(assistantId, instructions)
        {
            ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting,
            CollectionName = DefaultCollectionName,
        },
    };
}

public class CreateChatBotOutput
{
    [AssistantCreateOutput()]
    public AssistantCreateRequest? ChatBotCreateRequest { get; set; }

    [HttpResult]
    public IActionResult? HttpResponse { get; set; }
}

/**
 * The default storage account setting for the table storage account.
 * This constant is used to specify the connection string for the table storage
 * account
 * where chat data will be stored.
 */
final String DEFAULT_CHATSTORAGE = "AzureWebJobsStorage";

/**
 * The default collection name for the table storage account.
 * This constant is used to specify the collection name for the table storage
 * account
 * where chat data will be stored.
 */
final String DEFAULT_COLLECTION = "ChatState";

/*
 * HTTP PUT function that creates a new assistant chat bot with the specified ID.
 */
@FunctionName("CreateAssistant")
public HttpResponseMessage createAssistant(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.PUT}, 
        authLevel = AuthorizationLevel.FUNCTION, 
        route = "assistants/{assistantId}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("assistantId") String assistantId,
    @AssistantCreate(name = "AssistantCreate") OutputBinding<AssistantCreateRequest> message,
    final ExecutionContext context) {
        context.getLogger().info("Java HTTP trigger processed a request.");
        
        String instructions = "Don't make assumptions about what values to plug into functions.\n" +
                "Ask for clarification if a user request is ambiguous.";

        AssistantCreateRequest assistantCreateRequest = new AssistantCreateRequest(assistantId, instructions);
        assistantCreateRequest.setChatStorageConnectionSetting(DEFAULT_CHATSTORAGE);
        assistantCreateRequest.setCollectionName(DEFAULT_COLLECTION);

        message.setValue(assistantCreateRequest);
        JSONObject response = new JSONObject();
        response.put("assistantId", assistantId);
        
        return request.createResponseBuilder(HttpStatus.CREATED)
            .header("Content-Type", "application/json")
            .body(response.toString())
            .build();    
}

const { app, input, output } = require("@azure/functions");

const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";

const chatBotCreateOutput = output.generic({
    type: 'assistantCreate'
})
app.http('CreateAssistant', {
    methods: ['PUT'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraOutputs: [chatBotCreateOutput],
    handler: async (request, context) => {
        const assistantId = request.params.assistantId
        const instructions =
            `
            Don't make assumptions about what values to plug into functions.
            Ask for clarification if a user request is ambiguous.
            `
        const createRequest = {
            id: assistantId,
            instructions: instructions,
            chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
            collectionName: COLLECTION_NAME
        }
        context.extraOutputs.set(chatBotCreateOutput, createRequest)
        return { status: 202, jsonBody: { assistantId: assistantId } }
    }
})

import { HttpRequest, InvocationContext, app, input, output } from "@azure/functions"

const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";

const chatBotCreateOutput = output.generic({
    type: 'assistantCreate'
})
app.http('CreateAssistant', {
    methods: ['PUT'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraOutputs: [chatBotCreateOutput],
    handler: async (request: HttpRequest, context: InvocationContext) => {
        const assistantId = request.params.assistantId
        const instructions =
            `
            Don't make assumptions about what values to plug into functions.
            Ask for clarification if a user request is ambiguous.
            `
        const createRequest = {
            id: assistantId,
            instructions: instructions,
            chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
            collectionName: COLLECTION_NAME
        }
        context.extraOutputs.set(chatBotCreateOutput, createRequest)
        return { status: 202, jsonBody: { assistantId: assistantId } }
    }
})

Voici le fichier function.json pour Créer l’Assistant :

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "put"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "assistantCreate",
      "direction": "out",
      "dataType": "string",
      "name": "Requests"
    }
  ]
}

Pour plus d’informations sur les propriétés du fichier function.json, consultez la section Configuration.

using namespace System.Net

param($Request, $TriggerMetadata)

$assistantId = $Request.params.assistantId

$instructions = "Don't make assumptions about what values to plug into functions."
$instructions += "\nAsk for clarification if a user request is ambiguous."

$create_request = @{
    "id" = $assistantId
    "instructions" = $instructions
    "chatStorageConnectionSetting" = "AzureWebJobsStorage"
    "collectionName" = "ChatState"
}

Push-OutputBinding -Name Requests -Value (ConvertTo-Json $create_request)

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::Accepted
    Body       = (ConvertTo-Json @{ "assistantId" = $assistantId})
    Headers    = @{
        "Content-Type" = "application/json"
    }
})

DEFAULT_CHAT_STORAGE_SETTING = "AzureWebJobsStorage"
DEFAULT_CHAT_COLLECTION_NAME = "ChatState"


@apis.function_name("CreateAssistant")
@apis.route(route="assistants/{assistantId}", methods=["PUT"])
@apis.assistant_create_output(arg_name="requests")
def create_assistant(
    req: func.HttpRequest, requests: func.Out[str]
) -> func.HttpResponse:
    assistantId = req.route_params.get("assistantId")
    instructions = """
            Don't make assumptions about what values to plug into functions.
            Ask for clarification if a user request is ambiguous.
            """
    create_request = {
        "id": assistantId,
        "instructions": instructions,
        "chatStorageConnectionSetting": DEFAULT_CHAT_STORAGE_SETTING,
        "collectionName": DEFAULT_CHAT_COLLECTION_NAME,
    }
    requests.set(json.dumps(create_request))
    response_json = {"assistantId": assistantId}
    return func.HttpResponse(
        json.dumps(response_json), status_code=202, mimetype="application/json"
    )

Attributs

Appliquez l’attribut CreateAssistant pour définir une liaison de sortie de création d’assistant, qui prend en charge ces paramètres :

Paramètre	Descriptif
Id	Identificateur de l’assistant à créer.
Instructions	Facultatif. Instructions fournies à l’assistant à suivre.
ChatStorageConnectionSetting	Facultatif. Nom de la section de configuration des paramètres de table pour le stockage de conversation. La valeur par défaut est `AzureWebJobsStorage`.
CollectionName	Facultatif. Nom de la collection de tables pour le stockage de conversation. La valeur par défaut est `ChatState`.

Commentaires

L’annotation CreateAssistant vous permet de définir une liaison de sortie de création d’assistant, qui prend en charge les paramètres suivants :

Élément	Descriptif
nom	Obtient ou définit le nom de la liaison de sortie.
id	Identificateur de l’assistant à créer.
détaillées	Facultatif. Instructions fournies à l’assistant à suivre.
chatStorageConnectionSetting	Facultatif. Nom de la section de configuration des paramètres de table pour le stockage de conversation. La valeur par défaut est `AzureWebJobsStorage`.
collectionName	Facultatif. Nom de la collection de tables pour le stockage de conversation. La valeur par défaut est `ChatState`.

Décorateurs

Pendant la préversion, définissez la liaison de sortie en tant que liaison generic_output_binding de type createAssistant, qui prend en charge ces paramètres :

Paramètre	Descriptif
arg_name	Le nom de la variable qui représente le paramètre de liaison.
id	Identificateur de l’assistant à créer.
détaillées	Facultatif. Instructions fournies à l’assistant à suivre.
chat_storage_connection_setting	Facultatif. Nom de la section de configuration des paramètres de table pour le stockage de conversation. La valeur par défaut est `AzureWebJobsStorage`.
collection_name	Facultatif. Nom de la collection de tables pour le stockage de conversation. La valeur par défaut est `ChatState`.

Paramétrage

La liaison prend en charge ces propriétés de configuration que vous définissez dans le fichier function.json.

Propriété	Descriptif
type	Doit être `CreateAssistant`.
direction	Doit être `out`.
nom	Nom de la liaison de sortie.
id	Identificateur de l’assistant à créer.
détaillées	Facultatif. Instructions fournies à l’assistant à suivre.
chatStorageConnectionSetting	Facultatif. Nom de la section de configuration des paramètres de table pour le stockage de conversation. La valeur par défaut est `AzureWebJobsStorage`.
collectionName	Facultatif. Nom de la collection de tables pour le stockage de conversation. La valeur par défaut est `ChatState`.

Paramétrage

La liaison prend en charge ces propriétés, qui sont définies dans votre code :

Propriété	Descriptif
id	Identificateur de l’assistant à créer.
détaillées	Facultatif. Instructions fournies à l’assistant à suivre.
chatStorageConnectionSetting	Facultatif. Nom de la section de configuration des paramètres de table pour le stockage de conversation. La valeur par défaut est `AzureWebJobsStorage`.
collectionName	Facultatif. Nom de la collection de tables pour le stockage de conversation. La valeur par défaut est `ChatState`.

Utilisation

Pour obtenir des exemples complets, consultez la section Exemple.

Connections

Pour utiliser l’extension de liaison Azure OpenAI, vous devez spécifier une connexion à une définition de modèle OpenAI. Configurez la connexion du modèle OpenAI dans vos liaisons en utilisant l’une de ces approches :

Utilisez la AIConnectionName propriété de liaison (préférée pour Azure OpenAI).
Définissez AZURE_OPENAI_ENDPOINT et AZURE_OPENAI_KEY dans les paramètres de l’application (pour Azure OpenAI).
Réglez uniquement Open_API_Key dans les paramètres de l’application (pour https://api.openai.com).

La façon dont vous définissez la connexion dépend à la fois de l’API du modèle et de la méthode d’authentification, comme indiqué par le tableau suivant :

API d’authentification/modèle	Azure OpenAI	OpenAI (https://api.openai.com)
Connexion d’identité gérée	`AIConnectionName`	Non pris en charge
Référence Key Vault	`AZURE_OPENAI_ENDPOINT` `AZURE_OPENAI_KEY`	`Open_API_Key`
Référence de configuration de l’application	`AZURE_OPENAI_ENDPOINT` `AZURE_OPENAI_KEY`	`Open_API_Key`
Secret partagé	`AZURE_OPENAI_ENDPOINT` `AZURE_OPENAI_KEY`	`Open_API_Key`

Utilisez des connexions basées sur l’identité et la AIConnectionName propriété.

Lorsque vous utilisez AIConnectionName, la valeur de ce réglage de propriété dépend du type de connexion :

Connexion d’identité gérée : Cette AIConnectionName propriété est <CONNECTION_NAME_PREFIX> partagée par un groupe de paramètres qui définissent ensemble une connexion basée sur l’identité avec Azure OpenAI. Pour plus d’informations, voir Définir les connexions identités.
Référence Key Vault : Le AIConnectionName paramètre de propriété renvoie une référence Azure Key Vault à l’emplacement où la clé API est centralisée. Pour plus d’informations, voir Définir les connexions Key Vault.
Référence App Configuration : Le AIConnectionName paramètre de propriété renvoie une référence Azure App Configuration qui renvoie une clé API ou une référence Key Vault. Pour plus d’informations, consultez Azure App Configuration dans l’article sur les connexions.
Clé API : Le AIConnectionName paramètre de propriété se résout aux paramètres de l’application contenant directement le point de terminaison et la clé. Comme les clés partagées peuvent être compromises, utilisez des connexions d’identité gérées lorsque cela est possible. Pour plus d’informations, voir Définir les connexions.

Pour en savoir plus sur les connexions de liaisons, voir Gérer les connexions dans Azure Functions.

AIConnectionName, propriété
variables d’environnement

Les liaisons OpenAI incluent une AIConnectionName propriété que vous pouvez utiliser pour spécifier le <ConnectionNamePrefix> groupe de paramètres d’application qui définissent la connexion à Azure OpenAI :

Nom de la configuration	Descriptif
`<CONNECTION_NAME_PREFIX>__endpoint`	Définit le point de terminaison URI du service Azure OpenAI. Ce paramètre est toujours requis.
`<CONNECTION_NAME_PREFIX>__clientId`	Définit l’identité affectée par l’utilisateur spécifique à utiliser lors de l’obtention d’un jeton d’accès. Exige que `<CONNECTION_NAME_PREFIX>__credential` soit défini sur `managedidentity`. La propriété accepte un ID client correspondant à une identité attribuée par l’utilisateur affectée à l’application. Il incorrect de spécifier à la fois un ID de la ressource et un ID client. Si vous ne spécifiez pas cette propriété, l’identité attribuée par le système est utilisée. Cette propriété est utilisée différemment dans des scénarios de développement local lorsque `credential` ne doit pas être défini.
`<CONNECTION_NAME_PREFIX>__credential`	Définit la façon dont un jeton access est obtenu pour la connexion. Utiliser `managedidentity` pour l’authentification d’identité managée. Cette valeur n’est valide que lorsqu’une identité managée est disponible dans l’environnement d’hébergement.
`<CONNECTION_NAME_PREFIX>__managedIdentityResourceId`	Lorsque `credential` est défini à `managedidentity`, définissez cette propriété pour spécifier l’identifiant de ressource à utiliser lors de l’obtention d’un jeton. La propriété accepte un identifiant de ressource correspondant à l’ID de la ressource de l’identité managée définie par l’utilisateur. Il n’est pas correct de spécifier à la fois un ID de la ressource et un ID client. Si vous ne spécifiez ni l’un ni l’autre, l’identité attribuée par le système est utilisée. Cette propriété est utilisée différemment dans des scénarios de développement local lorsque `credential` ne doit pas être défini.
`<CONNECTION_NAME_PREFIX>__key`	Définit la clé secrète partagée nécessaire pour accéder au point de terminaison du service OpenAI Azure en utilisant une authentification basée sur une clé. En guise de bonne pratique en matière de sécurité, utilisez toujours Microsoft Entra ID avec des identités gérées pour l’authentification.

Considérez ces paramètres de connexion d’identité gérée lorsque vous définissez la AIConnectionName propriété à myAzureOpenAI:

myAzureOpenAI__endpoint=https://contoso.openai.azure.com/
myAzureOpenAI__credential=managedidentity
myAzureOpenAI__clientId=aaaaaaaa-bbbb-cccc-1111-222222222222

À l’exécution, l’hôte interprète ces paramètres comme un seul myAzureOpenAI paramètre :

"myAzureOpenAI":
{
    "endpoint": "https://contoso.openai.azure.com/",
    "credential": "managedidentity",
    "clientId": "aaaaaaaa-bbbb-cccc-1111-222222222222"
}

Lorsque vous utilisez des identités gérées, assurez-vous d’ajouter votre identité au rôle d’utilisateur OpenAI des services cognitifs .

Lors de l’exécution locale, ajoutez ces paramètres au fichierlocal.settings.json projet. Pour plus d’informations, consultez Développement local avec des connexions basées sur des identités.

Pour prendre en charge les applications et fournisseurs hérités autres qu’Azure OpenAI, définissez une authentification basée sur des clés pour OpenAI en utilisant ces variables d’environnement.

Nom de la variable	Descriptif
`AZURE_OPENAI_ENDPOINT`	Définit le point de terminaison d’URI de votre instance Azure OpenAI. N’utilisez pas avec `Open_API_Key`.
`AZURE_OPENAI_KEY`	Définit la clé secrète partagée nécessaire pour accéder à votre endpoint Azure OpenAI (`AZURE_OPENAI_ENDPOINT`) en utilisant une authentification basée sur une clé.
`Open_API_Key`	Définit la clé secrète partagée nécessaire pour accéder au `https://api.openai.com` point de terminaison en utilisant une authentification basée sur la clé.

Définissez ces variables dans les paramètres de votre application.

Lors de l’exécution locale, ajoutez ces paramètres au fichierlocal.settings.json projet.

Pour plus d’informations, consultez Utiliser des paramètres d’application.

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2026-07-22

La liaison de création de sortie de l’assistant Azure OpenAI pour Azure Functions

Exemple

Attributs

Commentaires

Décorateurs

Paramétrage

Paramétrage

Utilisation

Connections

Contenu connexe

Commentaires

Ressources supplémentaires