You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-29 22:27:42 +02:00
Доработка доков
This commit is contained in:
26
docs/en/md/Instructions/OpenAI.md
vendored
Normal file
26
docs/en/md/Instructions/OpenAI.md
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
id: OpenAI
|
||||
sidebar_class_name: OpenAI
|
||||
---
|
||||
|
||||
<img src={require('../../static/img/APIs/OpenAI.png').default} width='64px' />
|
||||
|
||||
# OpenAI
|
||||
|
||||
This section is devoted to the library for working with the OpenAI API in 1C:Enterprise, OneScript, and CLI. This page describes all actions required to fully start working with it.
|
||||
|
||||
## Preface
|
||||
|
||||
This library implements methods for working with any service that supports backward compatibility with the OpenAI API. During the development of this solution, LocalAI was used as a reference, which, like other available solutions, supports only a subset of the original OpenAI interface methods.
|
||||
|
||||
Also, when working with this library, it's important to remember that the result obtained — as well as the availability of certain function parameters — largely depends on the selected model and the level of API compatibility of the specific service with the original OpenAI API.
|
||||
|
||||
## Getting Started
|
||||
|
||||
In the classic implementation, the OpenAI API uses Bearer token-based authentication. The method of obtaining the token depends on the specific service you are using.
|
||||
|
||||
After acquiring the token, it must be passed into the `Token` parameter of each function in the library. You may also pass an empty string if authentication is not required, or use the `AdditionalHeaders` parameter to specify a custom authorization header when using alternative authentication methods.
|
||||
|
||||
In addition to the token, every API-related function includes a `URL` parameter, where you should provide the base address of the provider without `/v1/` or other additional path segments.
|
||||
|
||||
In functions where the set of fields can significantly vary depending on the model, there is also an `AdditionalParameters ` parameter, allowing you to add any necessary data to the request.
|
||||
3
docs/en/md/sidebars.js
vendored
3
docs/en/md/sidebars.js
vendored
@@ -81,10 +81,11 @@
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Artificial intelligence',
|
||||
label: 'Artificial Intelligence',
|
||||
className: 'AI',
|
||||
items:[
|
||||
{ type: 'category', link: {type: 'doc', id:'Instructions/Ollama'}, label: 'Ollama', className: 'Ollama', items:[{type: 'autogenerated', dirName: 'Ollama'}]},
|
||||
{ type: 'category', link: { type: 'doc', id: 'Instructions/OpenAI' }, label: 'OpenAI', className: 'OpenAI', items: [{ type: 'autogenerated', dirName: 'OpenAI' }] },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
20
docs/ru/md/Instructions/OpenAI.md
vendored
20
docs/ru/md/Instructions/OpenAI.md
vendored
@@ -6,6 +6,22 @@ keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3,
|
||||
|
||||
<img src={require('../../static/img/APIs/OpenAI.png').default} width='64px' />
|
||||
|
||||
# OpenAI/LocalAI
|
||||
# OpenAI
|
||||
|
||||
Этот раздел посвящен библиотеке для работы с OpenAI в 1С:Предприятие, OneScript и CLI. На данной странице описаны все действия, необходимые для полноценного начала работы
|
||||
Этот раздел посвящен библиотеке для работы с OpenAI API в 1С:Предприятие, OneScript и CLI. На данной странице описаны все действия, необходимые для полноценного начала работы
|
||||
|
||||
## Предисловие
|
||||
|
||||
Данная библиотека реализует методы для работы с любым сервисом, поддерживающим обратную совместимость с OpenAI API. При разработке решения использовался LocalAI, который, как и другие доступные решения, поддерживает лишь часть методов оригинального интерфейса OpenAI
|
||||
|
||||
Также при работе с данной библиотекой важно помнить, что получаемый результат, а также доступность тех или иных параметров функций зависит в основном от выбранной модели и уровня совместимости API конкретного сервиса с оригинальным OpenAI API
|
||||
|
||||
## Начало работы
|
||||
|
||||
В классическом варианте, OpenAI API использует Bearer авторизацию по токену. Его получение зависит от конкретного сервиса, который вы используете
|
||||
|
||||
После получения токена, его необходимо передавать в параметр `Токен` каждой из функций библиотеки. Также вы можете передать туда пустую строку, если авторизация не требуется, либо воспользоваться параметром `ДопЗаголовки` для указания собственного заголовка авторизации при использовании иного способа подтверждения входа
|
||||
|
||||
Кроме токена, каждая функция для работы с API имеет параметр `URL`, куда необходимо передать основной адрес провайдера без `/v1/ ` и других дополнительных элементов
|
||||
|
||||
В функциях, состав полей которых может сильно варьироваться от модели к модели, также присутствует параметр `ДопПараметры`, позволяющий дополнить запросы необходимыми данными
|
||||
2
docs/ru/md/sidebars.js
vendored
2
docs/ru/md/sidebars.js
vendored
@@ -85,7 +85,7 @@ const sidebars = {
|
||||
className: 'AI',
|
||||
items: [
|
||||
{ type: 'category', link: { type: 'doc', id: 'Instructions/Ollama' }, label: 'Ollama', className: 'Ollama', items: [{ type: 'autogenerated', dirName: 'Ollama' }] },
|
||||
{ type: 'category', link: { type: 'doc', id: 'Instructions/OpenAI' }, label: 'OpenAI/LocalAI', className: 'OpenAI', items: [{ type: 'autogenerated', dirName: 'OpenAI' }] },
|
||||
{ type: 'category', link: { type: 'doc', id: 'Instructions/OpenAI' }, label: 'OpenAI', className: 'OpenAI', items: [{ type: 'autogenerated', dirName: 'OpenAI' }] },
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user