Enlace de entrada de búsqueda semántica de Azure OpenAI para Azure Functions

Importante

La extensión de Azure OpenAI para Azure Functions está actualmente en versión preliminar.

El enlace de entrada de búsqueda semántica de Azure OpenAI permite usar la búsqueda semántica en las incrustaciones.

Para obtener información sobre la configuración y los detalles de configuración de la extensión de Azure OpenAI, consulte Extensiones de Azure OpenAI para Azure Functions. Para más información sobre la clasificación semántica en Búsqueda de Azure AI, consulte Clasificación semántica en Búsqueda de Azure AI.

Nota:

Las referencias y ejemplos solo se proporcionan para el modelo de Node.js v4.

Nota:

Las referencias y ejemplos solo se proporcionan para el modelo de Python v2.

Nota:

Aunque se admiten ambos modelos de proceso de C#, solo se proporcionan ejemplos de modelos de trabajo aislados.

Ejemplo

El soporte de Go no está disponible actualmente para esta asignación.

En este ejemplo se muestra cómo realizar una búsqueda semántica en un archivo.

[Function("PromptFile")]
public static IActionResult PromptFile(
    [HttpTrigger(AuthorizationLevel.Function, "post")] SemanticSearchRequest unused,
    [SemanticSearchInput("AISearchEndpoint", "openai-index", Query = "{prompt}", ChatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", EmbeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", AIConnectionName = "AzureOpenAI")] SemanticSearchContext result)
{
    return new ContentResult { Content = result.Response, ContentType = "text/plain" };
}

En este ejemplo se muestra cómo realizar una búsqueda semántica en un archivo.

@FunctionName("PromptFile")
public HttpResponseMessage promptFile(
    @HttpTrigger(
        name = "req", 
        methods = {HttpMethod.POST},
        authLevel = AuthorizationLevel.FUNCTION)
        HttpRequestMessage<SemanticSearchRequest> request,
    @SemanticSearch(name = "search", searchConnectionName = "AISearchEndpoint", collection = "openai-index", query = "{prompt}", chatModel = "%CHAT_MODEL_DEPLOYMENT_NAME%", embeddingsModel = "%EMBEDDING_MODEL_DEPLOYMENT_NAME%", isReasoningModel = false, aiConnectionName = "AzureOpenAI" ) String semanticSearchContext,
    final ExecutionContext context) {
        String response = new JSONObject(semanticSearchContext).getString("Response");
        return request.createResponseBuilder(HttpStatus.OK)
        .header("Content-Type", "application/json")
        .body(response)
        .build();        
}
public class SemanticSearchRequest {
    public String prompt;
    public String getPrompt() {
        return prompt;
    }
    public void setPrompt(String prompt) {
        this.prompt = prompt;
    }        
}

En este ejemplo se muestra cómo realizar una búsqueda semántica en un archivo.

const semanticSearchInput = input.generic({
    type: "semanticSearch",
    searchConnectionName: "AISearchEndpoint",
    collection: "openai-index",
    query: "{prompt}",
    chatModel: "%CHAT_MODEL_DEPLOYMENT_NAME%",
    embeddingsModel: "%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
    aiConnectionName: 'AzureOpenAI',
});

app.http('PromptFile', {
    methods: ['POST'],
    authLevel: 'function',
    extraInputs: [semanticSearchInput],
    handler: async (_request, context) => {
        var responseBody = context.extraInputs.get(semanticSearchInput)

        return { status: 200, body: responseBody.Response.trim() }
    }
});
const semanticSearchInput = input.generic({
    type: "semanticSearch",
    searchConnectionName: "AISearchEndpoint",
    collection: "openai-index",
    query: "{prompt}",
    chatModel: "%CHAT_MODEL_DEPLOYMENT_NAME%",
    aiConnectionName: 'AzureOpenAI',
    embeddingsModel: "%EMBEDDING_MODEL_DEPLOYMENT_NAME%"
});

app.http('PromptFile', {
    methods: ['POST'],
    authLevel: 'function',
    extraInputs: [semanticSearchInput],
    handler: async (_request, context) => {
        var responseBody: any = context.extraInputs.get(semanticSearchInput)

        return { status: 200, body: responseBody.Response.trim() }
    }
});

En este ejemplo se muestra cómo realizar una búsqueda semántica en un archivo.

Este es el archivo function.json para solicitar un archivo:

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    },
    {
      "name": "SemanticSearchInput",
      "type": "semanticSearch",
      "direction": "in",
      "searchConnectionName": "AISearchEndpoint",
      "collection": "openai-index",
      "query": "{prompt}",
      "chatModel": "%CHAT_MODEL_DEPLOYMENT_NAME%",
      "embeddingsModel": "%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
      "aiConnectionName": "AzureOpenAI"
    }
  ]
}

Para obtener más información sobre las propiedades del archivo function.json, consulte la sección de Configuración.

using namespace System.Net

param($Request, $TriggerMetadata, $SemanticSearchInput)

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

En este ejemplo se muestra cómo realizar una búsqueda semántica en un archivo.

@app.function_name("PromptFile")
@app.route(methods=["POST"])
@app.semantic_search_input(
    arg_name="result",
    search_connection_name="AISearchEndpoint",
    collection="openai-index",
    query="{prompt}",
    embeddings_model="%EMBEDDING_MODEL_DEPLOYMENT_NAME%",
    ai_connection_name="AzureOpenAI",
    chat_model="%CHAT_MODEL_DEPLOYMENT_NAME%",
)
def prompt_file(req: func.HttpRequest, result: str) -> func.HttpResponse:
    result_json = json.loads(result)
    response_json = {
        "content": result_json.get("Response"),
        "content_type": "text/plain",
    }
    return func.HttpResponse(
        json.dumps(response_json), status_code=200, mimetype="application/json"
    )

Atributos

Aplique el SemanticSearchInput atributo para definir un enlace de entrada de búsqueda semántica, que admite estos parámetros:

Parámetro Descripción
SearchConnectionName Nombre de una configuración de aplicación o una variable de entorno que contiene el valor de la cadena de conexión. Esta propiedad es compatible con expresiones de enlace.
Colección Nombre de la colección o tabla o índice que se va a buscar. Esta propiedad es compatible con expresiones de enlace.
Consulta Texto de consulta semántico que se va a usar para la búsqueda. Esta propiedad es compatible con expresiones de enlace.
EmbeddingsModel Opcional. Identificador del modelo que se va a usar para incrustaciones. El valor predeterminado es text-embedding-3-small. Esta propiedad es compatible con expresiones de enlace.
ChatModel Opcional. Obtiene o establece el nombre del modelo de lenguaje grande que se va a invocar para las respuestas de chat. El valor predeterminado es gpt-3.5-turbo. Esta propiedad es compatible con expresiones de enlace.
AIConnectionName Opcional. Obtiene o establece el nombre de la sección de configuración para la configuración de conectividad del servicio ai. Para Azure OpenAI: si se especifica, busca los valores "Punto de conexión" y "Clave" en esta sección de configuración. Si no se especifica o la sección no existe, vuelva a las variables de entorno: AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY. Para la autenticación de identidad administrada asignada por el usuario, esta propiedad es necesaria. Para el servicio OpenAI (que no es de Azure), establezca la variable de entorno OPENAI_API_KEY.
SystemPrompt Opcional. Obtiene o establece la solicitud del sistema que se va a usar para solicitar el modelo de lenguaje grande. El símbolo del sistema se anexa con el conocimiento que se captura como resultado de Query. El mensaje combinado se envía a la API de chat de OpenAI. Esta propiedad es compatible con expresiones de enlace.
MaxKnowledgeCount Opcional. Obtiene o establece el número de elementos de conocimiento que se insertarán en .SystemPrompt
IsReasoningModel Opcional. Obtiene o establece un valor que indica si el modelo de finalización de chat es un modelo de razonamiento. Esta opción es experimental y asociada al modelo de razonamiento hasta que todos los modelos tienen paridad en las propiedades esperadas, con un valor predeterminado de false.

anotaciones

La SemanticSearchInput anotación permite definir un enlace de entrada de búsqueda semántica, que admite estos parámetros:

Elemento Descripción
nombre Obtiene o establece el nombre del enlace de entrada.
searchConnectionName Nombre de una configuración de aplicación o una variable de entorno que contiene el valor de la cadena de conexión. Esta propiedad es compatible con expresiones de enlace.
Colección Nombre de la colección o tabla o índice que se va a buscar. Esta propiedad es compatible con expresiones de enlace.
consulta Texto de consulta semántico que se va a usar para la búsqueda. Esta propiedad es compatible con expresiones de enlace.
embeddingsModel Opcional. Identificador del modelo que se va a usar para incrustaciones. El valor predeterminado es text-embedding-3-small. Esta propiedad es compatible con expresiones de enlace.
chatModel Opcional. Obtiene o establece el nombre del modelo de lenguaje grande que se va a invocar para las respuestas de chat. El valor predeterminado es gpt-3.5-turbo. Esta propiedad es compatible con expresiones de enlace.
aiConnectionName Opcional. Obtiene o establece el nombre de la sección de configuración para la configuración de conectividad del servicio ai. Para Azure OpenAI: si se especifica, busca los valores "Punto de conexión" y "Clave" en esta sección de configuración. Si no se especifica o la sección no existe, vuelva a las variables de entorno: AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY. Para la autenticación de identidad administrada asignada por el usuario, esta propiedad es necesaria. Para el servicio OpenAI (que no es de Azure), establezca la variable de entorno OPENAI_API_KEY.
systemPrompt Opcional. Obtiene o establece la solicitud del sistema que se va a usar para solicitar el modelo de lenguaje grande. El símbolo del sistema se anexa con el conocimiento que se captura como resultado de Query. El mensaje combinado se envía a la API de chat de OpenAI. Esta propiedad es compatible con expresiones de enlace.
maxKnowledgeCount Opcional. Obtiene o establece el número de elementos de conocimiento que se insertarán en .SystemPrompt
isReasoningModel Opcional. Obtiene o establece un valor que indica si el modelo de finalización de chat es un modelo de razonamiento. Esta opción es experimental y asociada al modelo de razonamiento hasta que todos los modelos tienen paridad en las propiedades esperadas, con un valor predeterminado de false.

Elementos Decorator

Durante la versión preliminar, defina el enlace de entrada como un enlace generic_input_binding de tipo semanticSearch, que admite estos parámetros:

Parámetro Descripción
arg_name Nombre de la variable que representa el parámetro de enlace.
search_connection_name Nombre de una configuración de aplicación o una variable de entorno que contiene el valor de la cadena de conexión. Esta propiedad es compatible con expresiones de enlace.
Colección Nombre de la colección o tabla o índice que se va a buscar. Esta propiedad es compatible con expresiones de enlace.
consulta Texto de consulta semántico que se va a usar para la búsqueda. Esta propiedad es compatible con expresiones de enlace.
embeddings_model Opcional. Identificador del modelo que se va a usar para incrustaciones. El valor predeterminado es text-embedding-3-small. Esta propiedad es compatible con expresiones de enlace.
chat_model Opcional. Obtiene o establece el nombre del modelo de lenguaje grande que se va a invocar para las respuestas de chat. El valor predeterminado es gpt-3.5-turbo. Esta propiedad es compatible con expresiones de enlace.
ai_connection_name Opcional. Obtiene o establece el nombre de la sección de configuración para la configuración de conectividad del servicio ai. Para Azure OpenAI: si se especifica, busca los valores "Punto de conexión" y "Clave" en esta sección de configuración. Si no se especifica o la sección no existe, vuelva a las variables de entorno: AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY. Para la autenticación de identidad administrada asignada por el usuario, esta propiedad es necesaria. Para el servicio OpenAI (que no es de Azure), establezca la variable de entorno OPENAI_API_KEY.
system_prompt Opcional. Obtiene o establece la solicitud del sistema que se va a usar para solicitar el modelo de lenguaje grande. El símbolo del sistema se anexa con el conocimiento que se captura como resultado de Query. El mensaje combinado se envía a la API de chat de OpenAI. Esta propiedad es compatible con expresiones de enlace.
max_knowledge_count Opcional. Obtiene o establece el número de elementos de conocimiento que se insertarán en .SystemPrompt
is_reasoning _model Opcional. Obtiene o establece un valor que indica si el modelo de finalización de chat es un modelo de razonamiento. Esta opción es experimental y asociada al modelo de razonamiento hasta que todos los modelos tienen paridad en las propiedades esperadas, con un valor predeterminado de false.

Configuración

El enlace admite estas propiedades de configuración que se establecen en el archivo function.json.

Propiedad Descripción
tipo Debe ser semanticSearch.
dirección Debe ser in.
nombre Nombre del enlace de entrada.
searchConnectionName Obtiene o establece el nombre de una configuración de aplicación o una variable de entorno que contiene un valor de cadena de conexión. Esta propiedad es compatible con expresiones de enlace.
Colección Nombre de la colección o tabla o índice que se va a buscar. Esta propiedad es compatible con expresiones de enlace.
consulta Texto de consulta semántico que se va a usar para la búsqueda. Esta propiedad es compatible con expresiones de enlace.
embeddingsModel Opcional. Identificador del modelo que se va a usar para incrustaciones. El valor predeterminado es text-embedding-3-small. Esta propiedad es compatible con expresiones de enlace.
chatModel Opcional. Obtiene o establece el nombre del modelo de lenguaje grande que se va a invocar para las respuestas de chat. El valor predeterminado es gpt-3.5-turbo. Esta propiedad es compatible con expresiones de enlace.
aiConnectionName Opcional. Obtiene o establece el nombre de la sección de configuración para la configuración de conectividad del servicio ai. Para Azure OpenAI: si se especifica, busca los valores "Punto de conexión" y "Clave" en esta sección de configuración. Si no se especifica o la sección no existe, vuelva a las variables de entorno: AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY. Para la autenticación de identidad administrada asignada por el usuario, esta propiedad es necesaria. Para el servicio OpenAI (que no es de Azure), establezca la variable de entorno OPENAI_API_KEY.
systemPrompt Opcional. Obtiene o establece la solicitud del sistema que se va a usar para solicitar el modelo de lenguaje grande. El símbolo del sistema se anexa con el conocimiento que se captura como resultado de Query. El mensaje combinado se envía a la API de chat de OpenAI. Esta propiedad es compatible con expresiones de enlace.
maxKnowledgeCount Opcional. Obtiene o establece el número de elementos de conocimiento que se insertarán en .SystemPrompt
isReasoningModel Opcional. Obtiene o establece un valor que indica si el modelo de finalización de chat es un modelo de razonamiento. Esta opción es experimental y asociada al modelo de razonamiento hasta que todos los modelos tienen paridad en las propiedades esperadas, con un valor predeterminado de false.

Configuración

El enlace admite estas propiedades, que se definen en el código:

Propiedad Descripción
searchConnectionName Nombre de una configuración de aplicación o una variable de entorno que contiene el valor de la cadena de conexión. Esta propiedad es compatible con expresiones de enlace.
Colección Nombre de la colección o tabla o índice que se va a buscar. Esta propiedad es compatible con expresiones de enlace.
consulta Texto de consulta semántico que se va a usar para la búsqueda. Esta propiedad es compatible con expresiones de enlace.
embeddingsModel Opcional. Identificador del modelo que se va a usar para incrustaciones. El valor predeterminado es text-embedding-3-small. Esta propiedad es compatible con expresiones de enlace.
chatModel Opcional. Obtiene o establece el nombre del modelo de lenguaje grande que se va a invocar para las respuestas de chat. El valor predeterminado es gpt-3.5-turbo. Esta propiedad es compatible con expresiones de enlace.
aiConnectionName Opcional. Obtiene o establece el nombre de la sección de configuración para la configuración de conectividad del servicio ai. Para Azure OpenAI: si se especifica, busca los valores "Punto de conexión" y "Clave" en esta sección de configuración. Si no se especifica o la sección no existe, vuelva a las variables de entorno: AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY. Para la autenticación de identidad administrada asignada por el usuario, esta propiedad es necesaria. Para el servicio OpenAI (que no es de Azure), establezca la variable de entorno OPENAI_API_KEY.
systemPrompt Opcional. Obtiene o establece la solicitud del sistema que se va a usar para solicitar el modelo de lenguaje grande. El símbolo del sistema se anexa con el conocimiento que se captura como resultado de Query. El mensaje combinado se envía a la API de chat de OpenAI. Esta propiedad es compatible con expresiones de enlace.
maxKnowledgeCount Opcional. Obtiene o establece el número de elementos de conocimiento que se insertarán en .SystemPrompt
isReasoningModel Opcional. Obtiene o establece un valor que indica si el modelo de finalización de chat es un modelo de razonamiento. Esta opción es experimental y asociada al modelo de razonamiento hasta que todos los modelos tienen paridad en las propiedades esperadas, con un valor predeterminado de false.

Uso

Consulte la sección de ejemplos para ver ejemplos completos.

Connections

Para usar la extensión de enlace Azure OpenAI, necesitas especificar una conexión a una definición de modelo OpenAI. Establece la conexión del modelo OpenAI en tus bindings usando uno de estos enfoques:

  • Usa la AIConnectionName propiedad de binding (preferida para Azure OpenAI).
  • Configura AZURE_OPENAI_ENDPOINT y AZURE_OPENAI_KEY está en la configuración de la app (para Azure OpenAI).
  • Configurado solo Open_API_Key en la configuración de la app (para https://api.openai.com).

La forma en que se establece la conexión depende tanto de la API del modelo como del método de autenticación, como indica la siguiente tabla:

API de autenticación/modelo Azure OpenAI OpenAI (https://api.openai.com)
Conexión de identidad gestionada AIConnectionName No soportado
Referencia a Key Vault AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Referencia de configuración de aplicaciones AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key
Secreto compartido AZURE_OPENAI_ENDPOINT
AZURE_OPENAI_KEY
Open_API_Key

Utiliza conexiones gestionadas basadas en identidad y la AIConnectionName propiedad.

Cuando usas AIConnectionName, el valor de esta configuración de propiedad depende del tipo de conexión:

  • Conexión de identidad gestionada: La AIConnectionName propiedad es <CONNECTION_NAME_PREFIX> compartida por un grupo de configuraciones que en conjunto definen una conexión basada en identidad con Azure OpenAI. Para más información, véase Definir conexiones de identidad.
  • Referencia Key Vault: La AIConnectionName configuración de propiedades devuelve una referencia de Azure Key Vault a la ubicación donde se mantiene centralmente la clave API. Para más información, consulte Definir conexiones de Key Vault.
  • Referencia de configuración de la aplicación: La AIConnectionName configuración de propiedad devuelve una referencia de Azure App Configuration que devuelve una clave API o una referencia a Key Vault. Para más información, consulta Azure App Configuration en el artículo de conexiones.
  • Clave API: La AIConnectionName configuración de propiedades se resuelve a la configuración de la app que contiene directamente el endpoint y la clave. Como las claves compartidas pueden verse comprometidas, utiliza conexiones de identidad gestionadas siempre que sea posible. Para más información, véase Definir conexiones.

Para saber más sobre conexiones de bindings, consulta Gestionar conexiones en Azure Functions.

Las vinculaciones de OpenAI incluyen una AIConnectionName propiedad que puedes usar para especificar el <ConnectionNamePrefix> grupo de configuraciones de la app que definen la conexión a Azure OpenAI:

Nombre de la configuración Descripción
<CONNECTION_NAME_PREFIX>__endpoint Establece el extremo URI del servicio Azure OpenAI. Esta configuración siempre es necesaria.
<CONNECTION_NAME_PREFIX>__clientId Establece la identidad asignada por el usuario específica que se usará al obtener un token de acceso. Requiere que <CONNECTION_NAME_PREFIX>__credential se establezca en managedidentity. La propiedad acepta un identificador de cliente correspondiente a una identidad asignada por el usuario asignada a la aplicación. No es válido especificar un id. de recurso así como tampoco es válido un id. de cliente. Si no especificas esta propiedad, se utiliza la identidad asignada por el sistema. Esta propiedad se usa de forma diferente en escenarios de desarrollo locales, en los que no se debe establecer el elemento credential.
<CONNECTION_NAME_PREFIX>__credential Define cómo se obtiene un token de access para la conexión. Use managedidentity para la autenticación de identidad administrada. Este valor sólo es válido cuando existe una identidad administrada disponible en el entorno del hospedaje.
<CONNECTION_NAME_PREFIX>__managedIdentityResourceId Cuando credential se establece en managedidentity, establece esta propiedad para especificar el Identificador de recurso a usar al obtener un token. La propiedad acepta un identificador de recurso correspondiente al Id. de recurso de la identidad administrada definida por el usuario. No es válido especificar un Id. de recurso así como tampoco es válido un Id. de cliente. Si no especificas ninguno, se usa la identidad asignada por el sistema. Esta propiedad se usa de forma diferente en escenarios de desarrollo locales, en los que no se debe establecer el elemento credential.
<CONNECTION_NAME_PREFIX>__key Establece la clave secreta compartida necesaria para acceder al punto final del servicio OpenAI de Azure usando autenticación basada en claves. Como mejor práctica de seguridad, utiliza siempre Microsoft Entra ID con identidades gestionadas para la autenticación.

Considera estos ajustes de conexión de identidad gestionada cuando configures la AIConnectionName propiedad como myAzureOpenAI:

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

En tiempo de ejecución, el host interpreta estos ajustes como un solo myAzureOpenAI ajuste:

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

Cuando utilices identidades gestionadas, asegúrate de añadir tu identidad al rol de Usuario OpenAI de Servicios Cognitivos .

Al ejecutarlo localmente, añade estos ajustes al archivolocal.settings.json proyecto. Para obtener más información, consulte Desarrollo local con conexiones basadas en identidades.

Para más información, consulte Trabajar con la configuración de la aplicación.