Liaison d’entrée de requête de l’assistant Azure OpenAI pour Azure Functions

Important

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

La liaison d’entrée de requête de l’Assistant Azure OpenAI vous permet d’intégrer des requêtes d’API Assistants dans vos exécutions de code.

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 GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

/// <summary>
/// HTTP GET function that queries the conversation history of the assistant chat bot.
/// </summary>
[Function(nameof(GetChatState))]
public static IActionResult GetChatState(
   [HttpTrigger(AuthorizationLevel.Function, "get", Route = "assistants/{assistantId}")] HttpRequestData req,
   string assistantId,
   [AssistantQueryInput("{assistantId}", TimestampUtc = "{Query.timestampUTC}", ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting, CollectionName = DefaultCollectionName)] AssistantState state)
{
    return new OkObjectResult(state);
}

Cet exemple illustre le processus de création, où la fonction HTTP GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

/*
 * HTTP GET function that queries the conversation history of the assistant chat bot.
 */   
@FunctionName("GetChatState")
public HttpResponseMessage getChatState(
    @HttpTrigger(
        name = "req",
        methods = {HttpMethod.GET}, 
        authLevel = AuthorizationLevel.FUNCTION,
        route = "assistants/{assistantId}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("assistantId") String assistantId,        
    @AssistantQuery(name = "AssistantState", id = "{assistantId}", timestampUtc = "{Query.timestampUTC}", chatStorageConnectionSetting = DEFAULT_CHATSTORAGE, collectionName = DEFAULT_COLLECTION) AssistantState state,
    final ExecutionContext context) {
        return request.createResponseBuilder(HttpStatus.OK)
            .header("Content-Type", "application/json")
            .body(state)
            .build();
}

Cet exemple illustre le processus de création, où la fonction HTTP GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

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


const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }

Cet exemple illustre le processus de création, où la fonction HTTP GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

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


const chatBotQueryInput = input.generic({
    type: 'assistantQuery',
    id: '{assistantId}',
    timestampUtc: '{Query.timestampUTC}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('GetChatState', {
    methods: ['GET'],
    route: 'assistants/{assistantId}',
    authLevel: 'function',
    extraInputs: [chatBotQueryInput],
    handler: async (_, context) => {
        const state: any = context.extraInputs.get(chatBotQueryInput)
        return { status: 200, jsonBody: state }
    }

Cet exemple illustre le processus de création, où la fonction HTTP GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

Voici le fichier function.json pour obtenir l’état de conversation :

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "get"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "State",
      "type": "assistantQuery",
      "direction": "in",
      "dataType": "string",
      "id": "{assistantId}",
      "timestampUtc": "{Query.timestampUTC}",
      "chatStorageConnectionSetting": "AzureWebJobsStorage",
      "collectionName": "ChatState"
    }
  ]
}

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

using namespace System.Net

param($Request, $TriggerMetadata, $State)

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

Cet exemple illustre le processus de création, où la fonction HTTP GET qui interroge l’historique des conversations du bot de conversation de l’assistant. La réponse au prompt est retournée dans la réponse HTTP.

@apis.function_name("GetChatState")
@apis.route(route="assistants/{assistantId}", methods=["GET"])
@apis.assistant_query_input(
    arg_name="state",
    id="{assistantId}",
    timestamp_utc="{Query.timestampUTC}",
    chat_storage_connection_setting=DEFAULT_CHAT_STORAGE_SETTING,
    collection_name=DEFAULT_CHAT_COLLECTION_NAME,
)
def get_chat_state(req: func.HttpRequest, state: str) -> func.HttpResponse:

Attributs

Appliquez l’attribut AssistantQuery pour définir une liaison d’entrée de requête d’assistant, qui prend en charge ces paramètres :

Paramètre	Descriptif
Id	Obtient l’ID de l’assistant à interroger.
TimeStampUtc	Facultatif. Obtient ou définit l’horodatage du message le plus ancien dans l’historique de conversation à extraire. L’horodatage doit être au format ISO 8601, par exemple, 2023-08-01T00 :00 :00Z.

Commentaires

L’annotation assistantQuery vous permet de définir une liaison d’entrée de requête d’assistant, qui prend en charge ces paramètres :

Élément	Descriptif
nom	Obtient ou définit le nom de la liaison d’entrée.
id	Obtient l’ID de l’assistant à interroger.
timeStampUtc	Facultatif. Obtient ou définit l’horodatage du message le plus ancien dans l’historique de conversation à extraire. L’horodatage doit être au format ISO 8601, par exemple, 2023-08-01T00 :00 :00Z.

Décorateurs

Pendant la préversion, définissez la liaison d’entrée en tant que liaison generic_input_binding de type assistantQuery, 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	Obtient l’ID de l’assistant à interroger.
time_stamp_utc	Facultatif. Obtient ou définit l’horodatage du message le plus ancien dans l’historique de conversation à extraire. L’horodatage doit être au format ISO 8601, par exemple, 2023-08-01T00 :00 :00Z.

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 assistantQuery.
direction	Doit être in.
nom	Le nom de la liaison d’entrée.
id	Obtient l’ID de l’assistant à interroger.
timeStampUtc	Facultatif. Obtient ou définit l’horodatage du message le plus ancien dans l’historique de conversation à extraire. L’horodatage doit être au format ISO 8601, par exemple, 2023-08-01T00 :00 :00Z.

Paramétrage

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

Propriété	Descriptif
id	Obtient l’ID de l’assistant à interroger.
timeStampUtc	Facultatif. Obtient ou définit l’horodatage du message le plus ancien dans l’historique de conversation à extraire. L’horodatage doit être au format ISO 8601, par exemple, 2023-08-01T00 :00 :00Z.

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é

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.

variables d’environnement

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.

Contenu connexe

• Exemples d’assistant
• Extension Azure OpenAI
• Déclencheur d’assistant Azure OpenAI
• Liaison de création de sortie de l’assistant Azure OpenAI
• Liaison post-entrée de l’Assistant Azure OpenAI