genkitx-azure-openai
    Preparing search index...

    Interface AzureFunctionsOptions<C, T>

    Options for configuring the Azure Functions handler

    interface AzureFunctionsOptions<
        C extends ActionContext = ActionContext,
        T = unknown,
    > {
        authLevel?: "function" | "anonymous" | "admin";
        contextProvider?: ContextProvider<C, T>;
        cors?: boolean | CorsOptions;
        debug?: boolean;
        httpMethods?: string[];
        onError?: (
            error: Error,
        ) =>
            | { message: string; statusCode: number }
            | Promise<{ message: string; statusCode: number }>;
        route?: string;
        streaming?: boolean;
    }

    Type Parameters

    • C extends ActionContext = ActionContext
    • T = unknown
    Index

    Properties

    authLevel? contextProvider? cors? debug? httpMethods? onError? route? streaming?

    Properties

    authLevel?: "function" | "anonymous" | "admin"

    The authorization level for the Azure Functions HTTP trigger.

    'anonymous'
    contextProvider?: ContextProvider<C, T>

    Context provider that parses request data and returns context for the flow. This follows the same pattern as express, next.js, and other Genkit integrations.

    The context provider receives a RequestData object containing:

    • method: HTTP method ('GET', 'POST', etc.)
    • headers: Lowercase headers from the request
    • input: Parsed request body

    Return an ActionContext object that will be available via getContext() in the flow. Throw UserFacingError for authentication/authorization failures.

    import { UserFacingError } from 'genkit';

    const authProvider: ContextProvider = async (req) => {
      const token = req.headers['authorization'];
      if (!token) {
        throw new UserFacingError('UNAUTHENTICATED', 'Missing auth token');
      }
      const user = await verifyToken(token);
      return { auth: { user } };
    };

    export const handler = onCallGenkit(
      { contextProvider: authProvider },
      myFlow
    );
    cors?: boolean | CorsOptions

    CORS configuration. Set to false to disable CORS headers.

    { origin: '*', methods: ['POST', 'OPTIONS'] }
    debug?: boolean

    Whether to log incoming requests (for debugging).

    false
    httpMethods?: string[]

    HTTP methods to register for the Azure Functions HTTP trigger.

    ['POST', 'OPTIONS']
    onError?: (
        error: Error,
    ) =>
        | { message: string; statusCode: number }
        | Promise<{ message: string; statusCode: number }>

    Custom error handler for transforming errors before response.

    route?: string

    Optional custom route for the Azure Functions HTTP trigger. If not provided, the function name is used as the route.

    streaming?: boolean

    Whether to return a streaming handler. When true, the handler returns a streaming response using ReadableStream for incremental SSE delivery.

    The streaming handler is compatible with streamFlow from genkit/beta/client. For clients sending Accept: text/event-stream, it writes SSE chunks incrementally. Otherwise it falls back to a buffered JSON response.

    false

    export const handler = onCallGenkit(
      { streaming: true },
      myStreamingFlow
    );

    Settings

    Member Visibility

    On This Page

    Properties