1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-27 22:18:36 +02:00
Files
OpenIntegrations/docs/en/md/OpenAI/Requests-processing/Get-image-message-structure.mdx
Vitaly the Alpaca (bot) 347c900389 Main build (Jenkins)
2025-09-16 09:07:33 +03:00

77 lines
1.9 KiB
Plaintext
Vendored

---
sidebar_position: 8
description: Get image message structure and other functions to work with OpenAI in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, OpenAI]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Get image message structure
Gets the message structure based on the image for the request message list
`Function GetImageMessageStructure(Val Role, Val FileID, Val Text = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Role | --role | String | ✔ | Message source: system, user, developer |
| FileID | --file | String | ✔ | Image file ID. See UploadFile |
| Text | --prompt | String | ✖ | Input text query for image processing |
Returns: Structure Of KeyAndValue - Fields structure
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = "https://hut.openintegrations.dev/localai/";
Token = "12We...";
Image = "file-18";
Result = OPI_OpenAI.GetImageMessageStructure("user", Image, "What is in this image?");
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint openai GetImageMessageStructure \
--role "user" \
--file "file-9" \
--prompt "What is in this image?"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint openai GetImageMessageStructure ^
--role "user" ^
--file "file-9" ^
--prompt "What is in this image?"
```
</TabItem>
</Tabs>
```json title="Result"
{
"role": "user",
"content": [
{
"type": "input_image",
"file_id": "file-9"
},
{
"type": "input_text",
"text": "What is in this image?"
}
]
}
```