|
FP Perception 0.1.2
|
This document describes the image analysis driver plugins and how they integrate with the perception server.
Plugin type:
This driver is REST-backed and uses the OpenAI Responses API to analyze an image and return text.
The driver sends a request to https://api.openai.com/v1/responses with:
input_text containing the user promptinput_image containing a base64-encoded data URL (for example data:image/png;base64,...)The server passes both the image and the prompt to the driver.
The driver reads parameters under driver.image_analysis.OpenAIImageAnalysisDriver.*:
name (string): informational namemodel (string): model used for image analysis (current default gpt-5-mini)detail (string): image detail level (auto, low, high)test_file_path (string): image path used by the driver test() functiontest_prompt (string): prompt used by the driver test() functionREST settings (provided by RestBase):
driver.image_analysis.OpenAIImageAnalysisDriver.rest.uri (string): should be https://api.openai.com/v1/responsesdriver.image_analysis.OpenAIImageAnalysisDriver.rest.method (string): POSTdriver.image_analysis.OpenAIImageAnalysisDriver.rest.ssl_verify (bool)driver.image_analysis.OpenAIImageAnalysisDriver.rest.auth_type (string): BearerEnvironment variables:
OPENAI_API_KEY: required for authorizationThe driver returns a single string containing the model output text.
If the OpenAI response includes an error payload, the driver surfaces the error message as the returned string.