Vinculação de entrada de conclusão de texto do Azure OpenAI para o Azure Functions

Importante

A extensão do Azure OpenAI para o Azure Functions está atualmente em visualização.

A vinculação de entrada de conclusão de texto do Azure OpenAI permite que você traga as APIs de conclusão de texto de resultados para suas execuções de código. Você pode definir a associação para usar ambos os prompts predefinidos com parâmetros ou passar por um prompt inteiro.

Para obter informações sobre detalhes de instalação e configuração da extensão do Azure OpenAI, consulte Extensões do Azure OpenAI para Azure Functions. Para saber mais sobre as conclusões do Azure OpenAI, consulte Saiba como gerar ou manipular texto.

Observação

Referências e exemplos são fornecidos apenas para o modelo Node.js v4.

Observação

Referências e exemplos são fornecidos apenas para o modelo Python v2.

Observação

Embora ambos os modelos de processo C# sejam suportados, apenas exemplos de modelos de trabalho isolados são fornecidos.

Exemplo

Este exemplo demonstra o padrão de modelagem , onde a função de gatilho HTTP usa um name parâmetro e o incorpora em um prompt de texto, que é enviado para a API de conclusão do Azure OpenAI pela extensão. A resposta ao prompt é retornada na resposta HTTP.

[Function(nameof(WhoIs))]
public static IActionResult WhoIs(
    [HttpTrigger(AuthorizationLevel.Function, Route = "whois/{name}")] HttpRequestData req,
    [TextCompletionInput("Who is {name}?", ChatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%")] TextCompletionResponse response)
{
    return new OkObjectResult(response.Content);
}

Este exemplo usa um prompt como entrada, envia-o diretamente para a API de conclusão e retorna a resposta como saída.

[Function(nameof(GenericCompletion))]
public static IActionResult GenericCompletion(
    [HttpTrigger(AuthorizationLevel.Function, "post")] HttpRequestData req,
    [TextCompletionInput("{Prompt}", ChatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%")] TextCompletionResponse response,
    ILogger log)
{
    string text = response.Content;
    return new OkObjectResult(text);
}

@FunctionName("WhoIs")
public HttpResponseMessage whoIs(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.GET},
        authLevel = AuthorizationLevel.ANONYMOUS, 
        route = "whois/{name}") 
        HttpRequestMessage<Optional<String>> request,
    @BindingName("name") String name,
    @TextCompletion(prompt = "Who is {name}?", chatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", name = "response", isReasoningModel = false) TextCompletionResponse response,
    final ExecutionContext context) {
    return request.createResponseBuilder(HttpStatus.OK)
        .header("Content-Type", "application/json")
        .body(response.getContent())
        .build();
}

Este exemplo usa um prompt como entrada, envia-o diretamente para a API de conclusão e retorna a resposta como saída.

@FunctionName("GenericCompletion")
public HttpResponseMessage genericCompletion(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.POST},
        authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request,
    @TextCompletion(prompt = "{prompt}", chatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", name = "response", isReasoningModel = false) TextCompletionResponse response,
    final ExecutionContext context) {
    return request.createResponseBuilder(HttpStatus.OK)
        .header("Content-Type", "application/json")
        .body(response.getContent())
        .build();
}

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

// This OpenAI completion input requires a {name} binding value.
const openAICompletionInput = input.generic({
    prompt: 'Who is {name}?',
    maxTokens: '100',
    type: 'textCompletion',
    chatModel: '%CHAT_MODEL_DEPLOYMENT_NAME%'
})

app.http('whois', {
    methods: ['GET'],
    route: 'whois/{name}',
    authLevel: 'function',
    extraInputs: [openAICompletionInput],
    handler: async (_request, context) => {
        var response = context.extraInputs.get(openAICompletionInput)
        return { body: response.content.trim() }
    }
});

import { app, input } from "@azure/functions";

// This OpenAI completion input requires a {name} binding value.
const openAICompletionInput = input.generic({
    prompt: 'Who is {name}?',
    maxTokens: '100',
    type: 'textCompletion',
    chatModel: '%CHAT_MODEL_DEPLOYMENT_NAME%'
})

app.http('whois', {
    methods: ['GET'],
    route: 'whois/{name}',
    authLevel: 'function',
    extraInputs: [openAICompletionInput],
    handler: async (_request, context) => {
        var response: any = context.extraInputs.get(openAICompletionInput)
        return { body: response.content.trim() }
    }
});

Aqui está o arquivo function.json para TextCompletionResponse:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "route": "whois/{name}",
      "methods": [
        "get"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "type": "textCompletion",
      "direction": "in",
      "name": "TextCompletionResponse",
      "prompt": "Who is {name}?",
      "maxTokens": "100",
      "chatModel": "%CHAT_MODEL_DEPLOYMENT_NAME%"
    }
  ]
}

Para obter mais informações sobre function.json propriedades do arquivo, consulte a seção Configuração .

O código simplesmente retorna o texto da API de conclusão como resposta:

using namespace System.Net

param($Request, $TriggerMetadata, $TextCompletionResponse)

Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
        StatusCode = [HttpStatusCode]::OK
        Body       = $TextCompletionResponse.Content
    })

@app.route(route="whois/{name}", methods=["GET"])
@app.text_completion_input(
    arg_name="response",
    prompt="Who is {name}?",
    max_tokens="100",
    chat_model="%CHAT_MODEL_DEPLOYMENT_NAME%",
)
def whois(req: func.HttpRequest, response: str) -> func.HttpResponse:
    response_json = json.loads(response)
    return func.HttpResponse(response_json["content"], status_code=200)

Este exemplo usa um prompt como entrada, envia-o diretamente para a API de conclusão e retorna a resposta como saída.

@app.route(route="genericcompletion", methods=["POST"])
@app.text_completion_input(
    arg_name="response",
    prompt="{Prompt}",
    chat_model="%CHAT_MODEL_DEPLOYMENT_NAME%",
)
def genericcompletion(
    req: func.HttpRequest,
    response: str
) -> func.HttpResponse:
    response_json = json.loads(response)
    return func.HttpResponse(response_json["content"], status_code=200)

Atributos

O atributo específico que você aplica para definir uma vinculação de entrada de conclusão de texto depende do seu modo de processo C#.

Processo isolado
Em andamento

No modelo de trabalho isolado, aplique TextCompletionInput para definir uma vinculação de entrada de conclusão de texto.

O atributo suporta estes parâmetros:

Parâmetro	Descrição
Prompt	Obtém ou define o prompt para gerar completações, codificado como uma cadeia de caracteres.
AIConnectionName	Opcional. Obtém ou define o nome da seção de configuração para as configurações de conectividade do serviço de IA. Para o Azure OpenAI: Se especificado, procure os valores "Endpoint" e "Key" nesta seção de configuração. Se não for especificado ou a seção não existir, recorrerá às variáveis de ambiente: AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY. Para autenticação de identidade gerenciada atribuída pelo usuário, essa propriedade é necessária. Para o serviço OpenAI (não Azure), defina a variável de ambiente OPENAI_API_KEY.
Modelo de Bate-papo	Opcional. Obtém ou define a ID do modelo a ser usada como uma cadeia de caracteres, com um valor padrão de `gpt-3.5-turbo`.
Temperatura	Opcional. Obtém ou define a temperatura de amostragem a ser usada, como uma cadeia de caracteres entre `0` e `2`. Valores mais altos (`0.8`) tornam a saída mais aleatória, enquanto valores mais baixos como (`0.2`) tornam a saída mais focada e determinística. Você deve usar um ou `TemperatureTopP`, mas não ambos.
TopP	Opcional. Obtém ou define uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, como uma corda. Neste método de amostragem, o modelo considera os resultados dos tokens com `top_p` massa de probabilidade. Isso significa que `0.1` apenas os tokens que compõem o top 10% massa de probabilidade são considerados. Você deve usar um ou `TemperatureTopP`, mas não ambos.
MaxTokens	Opcional. Obtém ou define o número máximo de tokens a serem gerados na conclusão, como uma cadeia de caracteres com um padrão de `100`. A contagem de tokens do seu prompt mais `max_tokens` não pode exceder o comprimento de contexto do modelo. A maioria dos modelos tem um comprimento de contexto de 2.048 tokens (exceto os modelos mais recentes, que suportam 4096).
IsReasoningModel	Opcional. Obtém ou define um valor que indica se o modelo de conclusão de chat é um modelo de raciocínio. Esta opção é experimental e associada ao modelo de raciocínio até que todos os modelos tenham paridade nas propriedades esperadas, com um valor padrão de `false`.

Anotações

A TextCompletion anotação permite definir uma vinculação de entrada de conclusão de texto, que suporta estes parâmetros:

Elemento	Descrição
Nome	Obtém ou define o nome da ligação de entrada.
Prompt	Obtém ou define o prompt para gerar completações, codificado como uma cadeia de caracteres.
aiConnectionName	Opcional. Obtém ou define o nome da seção de configuração para as configurações de conectividade do serviço de IA. Para o Azure OpenAI: Se especificado, procure os valores "Endpoint" e "Key" nesta seção de configuração. Se não for especificado ou a seção não existir, recorrerá às variáveis de ambiente: AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY. Para autenticação de identidade gerenciada atribuída pelo usuário, essa propriedade é necessária. Para o serviço OpenAI (não Azure), defina a variável de ambiente OPENAI_API_KEY.
chatModelo	Obtém ou define a ID do modelo a ser usada como uma cadeia de caracteres, com um valor padrão de `gpt-3.5-turbo`.
temperatura	Opcional. Obtém ou define a temperatura de amostragem a ser usada, como uma cadeia de caracteres entre `0` e `2`. Valores mais altos (`0.8`) tornam a saída mais aleatória, enquanto valores mais baixos como (`0.2`) tornam a saída mais focada e determinística. Você deve usar um ou `TemperatureTopP`, mas não ambos.
topP	Opcional. Obtém ou define uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, como uma corda. Neste método de amostragem, o modelo considera os resultados dos tokens com `top_p` massa de probabilidade. Isso significa que `0.1` apenas os tokens que compõem o top 10% massa de probabilidade são considerados. Você deve usar um ou `TemperatureTopP`, mas não ambos.
maxTokens	Opcional. Obtém ou define o número máximo de tokens a serem gerados na conclusão, como uma cadeia de caracteres com um padrão de `100`. A contagem de tokens do seu prompt mais `max_tokens` não pode exceder o comprimento de contexto do modelo. A maioria dos modelos tem um comprimento de contexto de 2.048 tokens (exceto os modelos mais recentes, que suportam 4096).
isReasoningModel	Opcional. Obtém ou define um valor que indica se o modelo de conclusão de chat é um modelo de raciocínio. Esta opção é experimental e associada ao modelo de raciocínio até que todos os modelos tenham paridade nas propriedades esperadas, com um valor padrão de `false`.

Decoradores

Durante a visualização, defina a ligação de entrada como uma generic_input_binding associação do tipo textCompletion, que suporta estes parâmetros:

Parâmetro	Descrição
arg_name	O nome da variável que representa o parâmetro de ligação.
Prompt	Obtém ou define o prompt para gerar completações, codificado como uma cadeia de caracteres.
ai_connection_name	Opcional. Obtém ou define o nome da seção de configuração para as configurações de conectividade do serviço de IA. Para o Azure OpenAI: Se especificado, procure os valores "Endpoint" e "Key" nesta seção de configuração. Se não for especificado ou a seção não existir, recorrerá às variáveis de ambiente: AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY. Para autenticação de identidade gerenciada atribuída pelo usuário, essa propriedade é necessária. Para o serviço OpenAI (não Azure), defina a variável de ambiente OPENAI_API_KEY.
chat_model	Obtém ou define a ID do modelo a ser usada como uma cadeia de caracteres, com um valor padrão de `gpt-3.5-turbo`.
temperatura	Opcional. Obtém ou define a temperatura de amostragem a ser usada, como uma cadeia de caracteres entre `0` e `2`. Valores mais altos (`0.8`) tornam a saída mais aleatória, enquanto valores mais baixos como (`0.2`) tornam a saída mais focada e determinística. Você deve usar um ou `TemperatureTopP`, mas não ambos.
top_p	Opcional. Obtém ou define uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, como uma corda. Neste método de amostragem, o modelo considera os resultados dos tokens com `top_p` massa de probabilidade. Isso significa que `0.1` apenas os tokens que compõem o top 10% massa de probabilidade são considerados. Você deve usar um ou `TemperatureTopP`, mas não ambos.
max_tokens	Opcional. Obtém ou define o número máximo de tokens a serem gerados na conclusão, como uma cadeia de caracteres com um padrão de `100`. A contagem de tokens do seu prompt mais `max_tokens` não pode exceder o comprimento de contexto do modelo. A maioria dos modelos tem um comprimento de contexto de 2.048 tokens (exceto os modelos mais recentes, que suportam 4096).
is_reasoning _model	Opcional. Obtém ou define um valor que indica se o modelo de conclusão de chat é um modelo de raciocínio. Esta opção é experimental e associada ao modelo de raciocínio até que todos os modelos tenham paridade nas propriedades esperadas, com um valor padrão de `false`.

Configuração

A associação suporta essas propriedades de configuração definidas no arquivo function.json.

Propriedade	Descrição
tipo	Deve ser `textCompletion`.
direção	Deve ser `in`.
Nome	O nome da ligação de entrada.
Prompt	Obtém ou define o prompt para gerar completações, codificado como uma cadeia de caracteres.
aiConnectionName	Opcional. Obtém ou define o nome da seção de configuração para as configurações de conectividade do serviço de IA. Para o Azure OpenAI: Se especificado, procure os valores "Endpoint" e "Key" nesta seção de configuração. Se não for especificado ou a seção não existir, recorrerá às variáveis de ambiente: AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY. Para autenticação de identidade gerenciada atribuída pelo usuário, essa propriedade é necessária. Para o serviço OpenAI (não Azure), defina a variável de ambiente OPENAI_API_KEY.
chatModelo	Obtém ou define a ID do modelo a ser usada como uma cadeia de caracteres, com um valor padrão de `gpt-3.5-turbo`.
temperatura	Opcional. Obtém ou define a temperatura de amostragem a ser usada, como uma cadeia de caracteres entre `0` e `2`. Valores mais altos (`0.8`) tornam a saída mais aleatória, enquanto valores mais baixos como (`0.2`) tornam a saída mais focada e determinística. Você deve usar um ou `TemperatureTopP`, mas não ambos.
topP	Opcional. Obtém ou define uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, como uma corda. Neste método de amostragem, o modelo considera os resultados dos tokens com `top_p` massa de probabilidade. Isso significa que `0.1` apenas os tokens que compõem o top 10% massa de probabilidade são considerados. Você deve usar um ou `TemperatureTopP`, mas não ambos.
maxTokens	Opcional. Obtém ou define o número máximo de tokens a serem gerados na conclusão, como uma cadeia de caracteres com um padrão de `100`. A contagem de tokens do seu prompt mais `max_tokens` não pode exceder o comprimento de contexto do modelo. A maioria dos modelos tem um comprimento de contexto de 2.048 tokens (exceto os modelos mais recentes, que suportam 4096).
isReasoningModel	Opcional. Obtém ou define um valor que indica se o modelo de conclusão de chat é um modelo de raciocínio. Esta opção é experimental e associada ao modelo de raciocínio até que todos os modelos tenham paridade nas propriedades esperadas, com um valor padrão de `false`.

Configuração

A associação suporta estas propriedades, que são definidas no seu código:

Propriedade	Descrição
Prompt	Obtém ou define o prompt para gerar completações, codificado como uma cadeia de caracteres.
aiConnectionName	Opcional. Obtém ou define o nome da seção de configuração para as configurações de conectividade do serviço de IA. Para o Azure OpenAI: Se especificado, procure os valores "Endpoint" e "Key" nesta seção de configuração. Se não for especificado ou a seção não existir, recorrerá às variáveis de ambiente: AZURE_OPENAI_ENDPOINT e AZURE_OPENAI_KEY. Para autenticação de identidade gerenciada atribuída pelo usuário, essa propriedade é necessária. Para o serviço OpenAI (não Azure), defina a variável de ambiente OPENAI_API_KEY.
chatModelo	Obtém ou define a ID do modelo a ser usada como uma cadeia de caracteres, com um valor padrão de `gpt-3.5-turbo`.
temperatura	Opcional. Obtém ou define a temperatura de amostragem a ser usada, como uma cadeia de caracteres entre `0` e `2`. Valores mais altos (`0.8`) tornam a saída mais aleatória, enquanto valores mais baixos como (`0.2`) tornam a saída mais focada e determinística. Você deve usar um ou `TemperatureTopP`, mas não ambos.
topP	Opcional. Obtém ou define uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, como uma corda. Neste método de amostragem, o modelo considera os resultados dos tokens com `top_p` massa de probabilidade. Isso significa que `0.1` apenas os tokens que compõem o top 10% massa de probabilidade são considerados. Você deve usar um ou `TemperatureTopP`, mas não ambos.
maxTokens	Opcional. Obtém ou define o número máximo de tokens a serem gerados na conclusão, como uma cadeia de caracteres com um padrão de `100`. A contagem de tokens do seu prompt mais `max_tokens` não pode exceder o comprimento de contexto do modelo. A maioria dos modelos tem um comprimento de contexto de 2.048 tokens (exceto os modelos mais recentes, que suportam 4096).
isReasoningModel	Opcional. Obtém ou define um valor que indica se o modelo de conclusão de chat é um modelo de raciocínio. Esta opção é experimental e associada ao modelo de raciocínio até que todos os modelos tenham paridade nas propriedades esperadas, com um valor padrão de `false`.

Utilização

Consulte a seção Exemplo para obter exemplos completos.

Comentários

Esta página foi útil?

Last updated on 2025-05-20

Partilhar via

Vinculação de entrada de conclusão de texto do Azure OpenAI para o Azure Functions

Exemplo

Atributos

Anotações

Decoradores

Configuração

Configuração

Utilização

Conteúdo relacionado

Comentários

Recursos adicionais