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

Threads - List Threads

  • Ссылка
Служба:
AI Foundry
Версия API:
v1

Возвращает список созданных ранее потоков.

GET {endpoint}/threads?api-version=v1
С использованием необязательных параметров: 
GET {endpoint}/threads?api-version=v1&limit={limit}&order={order}&after={after}&before={before}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

Конечная точка проекта в виде: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.
after
 query

string

Курсор для использования в разбиении на страницы. После этого является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать after=obj_foo, чтобы получить следующую страницу списка.
before
 query

string

Курсор для использования в разбиении на страницы. прежде чем является идентификатором объекта, который определяет место в списке. Например, если вы делаете запрос списка и получаете 100 объектов, заканчивая obj_foo, последующий вызов может включать до=obj_foo, чтобы получить предыдущую страницу списка.
limit
 query

integer (int32)

Ограничение количества возвращаемых объектов. Ограничение может быть от 1 до 100, а значение по умолчанию — 20.
order
 query

ListSortOrder

Сортировка по created_at метке времени объектов. asc для возрастания порядка и desc для убывающего порядка.

Ответы

Имя Тип Описание
200 OK

Запрашиваемый список потоков.
Other Status Codes

AgentV1Error

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://ai.azure.com/.default

Примеры

Threads_ListThreads_MaximumSet
Threads_ListThreads_MinimumSet

Threads_ListThreads_MaximumSet

Образец запроса

GET {endpoint}/threads?api-version=v1&limit=16&order=asc&after=mwffzlurbubmwolotcxl&before=ytakgvhqriykuirndnrqcuekophged

Пример ответа

Код состояния:
200 
{
  "data": [
    {
      "id": "qkbkoichtwadx",
      "object": "thread",
      "created_at": 18,
      "tool_resources": {
        "code_interpreter": {
          "file_ids": [
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv",
            "lrxbwhmsewnzmfushighvgbv"
          ],
          "data_sources": [
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            },
            {
              "uri": "jtookuzhwojyylbips",
              "type": "uri_asset"
            }
          ]
        },
        "file_search": {
          "vector_store_ids": [
            "ezeljyggzgyvliaif"
          ],
          "vector_stores": [
            {
              "name": "jtpzxxafdiapssaxxruzkitbpmdovh",
              "configuration": {
                "data_sources": [
                  {
                    "uri": "jtookuzhwojyylbips",
                    "type": "uri_asset"
                  }
                ]
              }
            }
          ]
        },
        "azure_ai_search": {
          "indexes": [
            {
              "index_connection_id": "nfeoncaophxqnhmsewmckkwbyv",
              "index_name": "nidrehbyzdpvelcltqqloq",
              "query_type": "simple",
              "top_k": 4,
              "filter": "hrfico",
              "index_asset_id": "wybmymisqviehjpplxbrjtmaxejq"
            }
          ]
        }
      },
      "metadata": {
        "key3754": "jnoo"
      }
    }
  ],
  "last_id": "bgzaixxumgscynjpbyeyymj",
  "has_more": true
}

Threads_ListThreads_MinimumSet

Образец запроса

GET {endpoint}/threads?api-version=v1

Пример ответа

Код состояния:
200 
{
  "data": [
    {
      "id": "qkbkoichtwadx",
      "object": "thread",
      "created_at": 18,
      "tool_resources": {},
      "metadata": {}
    }
  ],
  "has_more": true
}

Определения

Имя Описание
AgentErrorDetail

Описывает сведения об ошибках, возвращаемые API агентов.
AgentV1Error

Полезная нагрузка ошибки, возвращенная API агентов.
ListSortOrder

Доступные варианты сортировки при запросе списка объектов ответа.

AgentErrorDetail

Object

Описывает сведения об ошибках, возвращаемые API агентов.

Имя Тип Описание
code

string

Машиночитаемый код ошибки.
message

string

Удобочитаемое описание ошибки.
param

string

Имя параметра, вызвавшего ошибку, если применимо.
type

string

Идентификатор типа ошибки (например, invalid_request_error).

AgentV1Error

Object

Полезная нагрузка ошибки, возвращенная API агентов.

Имя Тип Описание
error

AgentErrorDetail

Представляет собой ошибку.

ListSortOrder

Перечисление

Доступные варианты сортировки при запросе списка объектов ответа.

Значение Описание
asc

Задает порядок сортировки по возрастанию.
desc

Задает порядок сортировки по убыванию.