你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure Functions 的 Azure OpenAI 助手发布输入绑定

重要

适用于 Azure Functions 的 Azure OpenAI 扩展目前为预览版。

通过 Azure OpenAI 助手发布输入绑定，可向助手聊天机器人发送提示。

如需了解有关 Azure OpenAI 扩展的设置和配置详细信息，请参阅适用于 Azure Functions 的 Azure OpenAI 扩展。 若要了解有关 Azure OpenAI 助手的详细信息，请参阅 [Azure OpenAI 助手 API]（../ai-services/openai/

注意

仅提供了适用于 Node.js v4 模型的参考和示例。

注意

仅提供了适用于 Python v2 模型的参考和示例。

注意

虽然支持这两个 C# 进程模型，但仅 提供了独立的辅助角色模型 示例。

示例

此示例演示了创建过程，过程中 HTTP POST 函数将用户提示发送到助手聊天机器人。 对提示的回复在 HTTP 响应中返回。

/// <summary>
/// HTTP POST function that sends user prompts to the assistant chat bot.
/// </summary>
[Function(nameof(PostUserQuery))]
public static async Task<IActionResult> PostUserQuery(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "assistants/{assistantId}")] HttpRequestData req,
    string assistantId,
    [AssistantPostInput("{assistantId}", "{Query.message}", Model = "%CHAT_MODEL_DEPLOYMENT_NAME%", ChatStorageConnectionSetting = DefaultChatStorageConnectionSetting, CollectionName = DefaultCollectionName)] AssistantState state)
{
    return new OkObjectResult(state.RecentMessages.Any() ? state.RecentMessages[state.RecentMessages.Count - 1].Content : "No response returned.");
}

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

此示例演示了创建过程，过程中 HTTP POST 函数将用户提示发送到助手聊天机器人。 对提示的回复在 HTTP 响应中返回。

public HttpResponseMessage getChatState(
    @HttpTrigger(
        name = "req",
        methods = {HttpMethod.GET}, 
        authLevel = AuthorizationLevel.ANONYMOUS,
        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();
}

/*
 * HTTP POST function that sends user prompts to the assistant chat bot.
 */ 
@FunctionName("PostUserResponse")
public HttpResponseMessage postUserResponse(

此示例演示了创建过程，过程中 HTTP POST 函数将用户提示发送到助手聊天机器人。 对提示的回复在 HTTP 响应中返回。

const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";
const assistantPostInput = input.generic({
    type: 'assistantPost',
    id: '{assistantId}',
    model: '%CHAT_MODEL_DEPLOYMENT_NAME%',
    userMessage: '{Query.message}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('PostUserResponse', {
    methods: ['POST'],
    route: 'assistants/{assistantId}',
    authLevel: 'anonymous',
    extraInputs: [assistantPostInput],
    handler: async (_, context) => {
        const chatState = context.extraInputs.get(assistantPostInput)
        const content = chatState.recentMessages[0].content
        return {
            status: 200,
            body: content,
            headers: {
                'Content-Type': 'text/plain'
            }
        };
    }
})

const CHAT_STORAGE_CONNECTION_SETTING = "AzureWebJobsStorage";
const COLLECTION_NAME = "ChatState";
const assistantPostInput = input.generic({
    type: 'assistantPost',
    id: '{assistantId}',
    model: '%CHAT_MODEL_DEPLOYMENT_NAME%',
    userMessage: '{Query.message}',
    chatStorageConnectionSetting: CHAT_STORAGE_CONNECTION_SETTING,
    collectionName: COLLECTION_NAME
})
app.http('PostUserResponse', {
    methods: ['POST'],
    route: 'assistants/{assistantId}',
    authLevel: 'anonymous',
    extraInputs: [assistantPostInput],
    handler: async (_, context) => {
        const chatState: any = context.extraInputs.get(assistantPostInput)
        const content = chatState.recentMessages[0].content
        return {
            status: 200,
            body: content,
            headers: {
                'Content-Type': 'text/plain'
            }
        };
    }
})

此示例演示了创建过程，过程中 HTTP POST 函数将用户提示发送到助手聊天机器人。 对提示的回复在 HTTP 响应中返回。

下面是 发布用户查询的function.json 文件：

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "assistants/{assistantId}",
      "methods": [
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "State",
      "type": "assistantPost",
      "direction": "in",
      "dataType": "string",
      "id": "{assistantId}",
      "userMessage": "{Query.message}",
      "model": "%CHAT_MODEL_DEPLOYMENT_NAME%",
      "chatStorageConnectionSetting": "AzureWebJobsStorage",
      "collectionName": "ChatState"
    }
  ]
}

有关 function.json 文件属性的详细信息，请参阅配置部分。

using namespace System.Net

param($Request, $TriggerMetadata, $State)

$recent_message_content = "No recent messages!"

if ($State.recentMessages.Count -gt 0) {
    $recent_message_content = $State.recentMessages[0].content
}

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

此示例演示了创建过程，过程中 HTTP POST 函数将用户提示发送到助手聊天机器人。 对提示的回复在 HTTP 响应中返回。

    response_json = {"assistantId": assistantId}
    return func.HttpResponse(json.dumps(response_json), status_code=202, mimetype="application/json")


@apis.function_name("PostUserQuery")
@apis.route(route="assistants/{assistantId}", methods=["POST"])
@apis.assistant_post_input(arg_name="state", id="{assistantId}", user_message="{Query.message}", model="%CHAT_MODEL_DEPLOYMENT_NAME%", chat_storage_connection_setting=DEFAULT_CHAT_STORAGE_SETTING, collection_name=DEFAULT_CHAT_COLLECTION_NAME)
def post_user_response(req: func.HttpRequest, state: str) -> func.HttpResponse:
    # Parse the JSON string into a dictionary
    data = json.loads(state)

特性

应用 PostUserQuery 特性以定义助手发布输入绑定，该绑定支持以下参数：

参数	说明
Id	要更新的助手的 ID。
型号	要使用的 OpenAI 聊天模型的名称。 对于 Azure OpenAI，此值是模型部署的名称。

批注

通过 PostUserQuery 注释，可定义助手发布输入绑定，该绑定支持以下参数：

元素	说明
name	输出绑定的名称。
id	要更新的助手的 ID。
model	要使用的 OpenAI 聊天模型的名称。 对于 Azure OpenAI，此值是模型部署的名称。

修饰符

在预览期间，将输出绑定定义为 postUserQuery 类型的 generic_output_binding 绑定，该绑定支持以下参数：

参数	说明
arg_name	表示绑定参数的变量的名称。
id	要更新的助手的 ID。
model	要使用的 OpenAI 聊天模型的名称。 对于 Azure OpenAI，此值是模型部署的名称。

配置

绑定支持在 function.json 文件中设置的这些配置属性。

properties	说明
type	必须是 PostUserQuery。
direction	必须是 out。
name	输出绑定的名称。
id	要更新的助手的 ID。
model	要使用的 OpenAI 聊天模型的名称。 对于 Azure OpenAI，此值是模型部署的名称。

配置

绑定支持以下属性，这些属性在代码中定义：

properties	说明
id	要更新的助手的 ID。
model	要使用的 OpenAI 聊天模型的名称。 对于 Azure OpenAI，此值是模型部署的名称。

使用情况

有关完整示例，请参阅示例部分。

相关内容

• 助手示例
• Azure OpenAI 扩展
• Azure OpenAI 助手触发器
• Azure OpenAI 助手查询输入绑定
• Azure OpenAI 助手创建输出绑定