Поделиться через

Справочник по потокам API Помощников (предварительная версия)

  • Статья

Примечание.

  • Поиск по файлам может получать до 10 000 файлов на помощника — 500 раз больше, чем раньше. Это быстрый процесс, который поддерживает параллельные многопоточные поисковые запросы, а также функции расширенного повторного ранжирования и перезаписи запросов.
    • Векторное хранилище — это новый объект в API. После добавления файла в векторное хранилище он автоматически анализируется, делится на блоки и кодируется в векторном представлении, чтобы подготовить к поиску по содержимому. Векторные хранилища можно использовать между разными помощниками и потоками, упрощая управление файлами и выставление счетов.
  • Мы добавили поддержку tool_choice параметра, который можно использовать для принудительного использования определенного средства (например, поиска файлов, интерпретатора кода или функции) в определенном запуске.

В этой статье приведена справочная документация по Python и REST для нового API Помощников (предварительная версия). Дополнительные пошаговые инструкции приведены в руководстве по началу работы.

Создание потока

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads?api-version=2024-08-01-preview

Создание потока.

Текст запроса

Имя. Type Обязательно Описание
messages array Необязательно Список сообщений для запуска потока.
metadata map Необязательно Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.
tool_resources object Необязательно Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.

свойства tool_resources

code_interpreter

Имя. Тип Описание По умолч.
file_ids array Список идентификаторов файлов, доступных средству code_interpreter. С инструментом может быть не более 20 файлов. []

file_search

Имя. Тип Описание По умолч.
vector_store_ids array Хранилище векторов, присоединенное к этому потоку. К потоку может быть подключено не более 1 векторного хранилища. []
vector_stores array Вспомогательный объект для создания хранилища векторов с file_ids и присоединения его к этому потоку. К потоку может быть подключено не более 1 векторного хранилища. []

Возвраты

Объект потока.

Пример: создание запроса потока

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

empty_thread = client.beta.threads.create()
print(empty_thread)

Получение потока

GET https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Извлекает поток.

Параметры пути

Параметр Type Обязательно Описание
thread_id строка Обязательное поле Идентификатор извлекаемого потока

Возвраты

Объект потока, соответствующий указанному идентификатору.

Пример: получение запроса потока

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_thread = client.beta.threads.retrieve("thread_abc123")
print(my_thread)

Изменение потока

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-08-01-preview

Изменяет поток.

Параметры пути

Параметр Type Обязательно Описание
thread_id строка Обязательное поле Идентификатор потока для изменения.

Текст запроса

Имя. Type Обязательно Описание
metadata map Необязательно Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.
tool_resources object Необязательно Набор ресурсов, доступных средствам помощника в этом потоке. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.

Возвраты

Измененный объект потока, соответствующий указанному идентификатору.

Пример: изменение запроса потока

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-08-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

my_updated_thread = client.beta.threads.update(
  "thread_abc123",
  metadata={
    "modified": "true",
    "user": "abc123"
  }
)
print(my_updated_thread)

Удаление потока

DELETE https://YOUR_RESOURCE_NAME.openai.azure.com/openai/threads/{thread_id}?api-version=2024-05-01-preview

Удаление потока.

Параметры пути

Параметр Type Обязательно Описание
thread_id строка Обязательное поле Идентификатор удаляемого потока.

Возвраты

Состояние удаления.

Пример: удаление запроса потока

from openai import AzureOpenAI
    
client = AzureOpenAI(
    api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
    api_version="2024-05-01-preview",
    azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )

response = client.beta.threads.delete("thread_abc123")
print(response)

Объект Thread

Поле Тип Описание:
id строка Идентификатор, на который можно ссылаться в конечных точках API.
object строка Тип объекта, который всегда является потоком.
created_at integer Метка времени Unix (в секундах) для момента создания потока.
metadata map Набор из 16 пар "ключ-значение", которые могут быть присоединены к объекту. Это может быть полезно для хранения дополнительных сведений об объекте в структурированном формате. Ключи могут содержать не более 64 символов, а значения могут содержать не более 512 символов.