Constructor
new ImageAnalysisService()
- Source:
Methods
call(user, prompt, image_url, engineopt) → {Promise.<Object>}
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
user |
string
|
|
|
The ID of the user accessing the Soffos API.
This string will be used for throttling and profanity tracking.
Soffos assumes that the owner of the api is an application (app) and that app has users.
Soffos API will accept any string." |
prompt |
string
|
|
|
the prompt to be sent to the LLM |
image_url |
string
|
|
|
the location of the image to be processed |
engine |
string
|
<optional>
|
null
|
The LLM engine to be used. |
- Source:
Returns:
analysis - the analysis of the image
-
Type
-
Promise.<Object>
Example
Examples are available at "https://github.com/Soffos-Inc/soffosai-js/tree/master/samples"
Parameters:
| Name |
Type |
Attributes |
Default |
Description |
name |
string
|
|
|
Reference name of this Service.
It will be used by the Pipeline to reference this Service. |
prompt |
string
|
InputConfig
|
|
|
the prompt to be sent to the LLM |
image_url |
string
|
InputConfig
|
|
|
the location of the image to be processed |
engine |
string
|
InputConfig
|
<optional>
|
null
|
The LLM engine to be used. |
- Source: