Compartilhar via

Threads - List Threads

  • Referência
Serviço:
AI Foundry
Versão da API:
v1

Obtém uma lista de threads que foram criados anteriormente.

GET {endpoint}/threads?api-version=v1
Com parâmetros opcionais: 
GET {endpoint}/threads?api-version=v1&limit={limit}&order={order}&after={after}&before={before}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string (uri)

Ponto final do projeto na forma de: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
after
 query

string

Um cursor para uso na paginação. depois é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir after=obj_foo para buscar a próxima página da lista.
before
 query

string

Um cursor para uso na paginação. antes é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir before=obj_foo para buscar a página anterior da lista.
limit
 query

integer (int32)

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o padrão é 20.
order
 query

ListSortOrder

Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente e desc para ordem decrescente.

Respostas

Nome Tipo Description
200 OK

A lista solicitada de threads.
Other Status Codes

AgentV1Error

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome Description
https://ai.azure.com/.default

Exemplos

Threads_ListThreads_MaximumSet
Threads_ListThreads_MinimumSet

Threads_ListThreads_MaximumSet

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "data": [
    {
      "id": "qkbkoichtwadx",
      "object": "thread",
      "created_at": 18,
      "tool_resources": {},
      "metadata": {}
    }
  ],
  "has_more": true
}

Definições

Nome Description
AgentErrorDetail

Descreve as informações de erro retornadas pela API dos agentes.
AgentV1Error

Carga de erro retornada pela API de agentes.
ListSortOrder

As opções de classificação disponíveis ao solicitar uma lista de objetos de resposta.

AgentErrorDetail

Objeto

Descreve as informações de erro retornadas pela API dos agentes.

Nome Tipo Description
code

string

Código de erro legível por máquina.
message

string

Descrição legível do erro.
param

string

Nome do parâmetro que causou o erro, se aplicável.
type

string

Identificador de tipo de erro (por exemplo, invalid_request_error).

AgentV1Error

Objeto

Carga de erro retornada pela API de agentes.

Nome Tipo Description
error

AgentErrorDetail

Representa o erro.

ListSortOrder

Enumeração

As opções de classificação disponíveis ao solicitar uma lista de objetos de resposta.

Valor Description
asc

Especifica uma ordem de classificação crescente.
desc

Especifica uma ordem de classificação decrescente.