Compartir a través de

List Agents - List Agents

  • Referencia
Servicio:
AI Foundry
Versión de la API:
v1

Obtiene una lista de agentes creados anteriormente.

GET {endpoint}/assistants?api-version=v1
Con parámetros opcionales: 
GET {endpoint}/assistants?api-version=v1&limit={limit}&order={order}&after={after}&before={before}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

Punto final del proyecto en forma de: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.
after
 query

string

Cursor para su uso en la paginación. después de es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir after=obj_foo para capturar la página siguiente de la lista.
before
 query

string

Cursor para su uso en la paginación. antes de es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.
limit
 query

integer (int32)

Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.
order
 query

ListSortOrder

Ordene por la created_at marca de tiempo de los objetos. asc para orden ascendente y desc para orden descendente.

Respuestas

Nombre Tipo Description
200 OK

La lista solicitada de agentes.
Other Status Codes

AgentV1Error

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

ListAgents_MaximumSet
ListAgents_MinimumSet

ListAgents_MaximumSet

Solicitud de ejemplo

GET {endpoint}/assistants?api-version=v1&limit=1&order=asc&after=uchhjzamqsqy&before=clwfmgfinrdbnj

Respuesta de muestra

status code:
200 
{
  "data": [
    {
      "id": "ldgcuidjvzrp",
      "object": "assistant",
      "created_at": 1,
      "name": "mldxpytbtdtrukktpciqtkcttk",
      "description": "qvci",
      "model": "farpqexpvlgrwtjwawkbryjrxmt",
      "instructions": "csqxezmbgdisjpndkhvxbrbwpeftb",
      "tools": [
        {
          "type": "ToolDefinition"
        }
      ],
      "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"
            }
          ]
        }
      },
      "temperature": 24,
      "top_p": 20,
      "metadata": {
        "key6403": "cafmabfintoktvmzcbkzrimxe"
      }
    }
  ],
  "last_id": "egzokahnspv",
  "has_more": true
}

ListAgents_MinimumSet

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "data": [
    {
      "id": "ldgcuidjvzrp",
      "object": "assistant",
      "created_at": 1,
      "name": "mldxpytbtdtrukktpciqtkcttk",
      "description": "qvci",
      "model": "farpqexpvlgrwtjwawkbryjrxmt",
      "instructions": "csqxezmbgdisjpndkhvxbrbwpeftb",
      "tools": [
        {
          "type": "ToolDefinition"
        }
      ],
      "tool_resources": {},
      "temperature": 24,
      "top_p": 20,
      "metadata": {}
    }
  ],
  "has_more": true
}

Definiciones

Nombre Description
AgentErrorDetail

Describe la información de error devuelta por la API de agentes.
AgentV1Error

Carga de error devuelta por la API de agentes.
ListSortOrder

Las opciones de ordenación disponibles al solicitar una lista de objetos de respuesta.

AgentErrorDetail

Object

Describe la información de error devuelta por la API de agentes.

Nombre Tipo Description
code

string

Código de error legible por máquina.
message

string

Descripción legible del error.
param

string

Nombre del parámetro que causó el error, si corresponde.
type

string

Identificador de tipo de error (p. ej. invalid_request_error).

AgentV1Error

Object

Carga de error devuelta por la API de agentes.

Nombre Tipo Description
error

AgentErrorDetail

Representa el error.

ListSortOrder

Enumeración

Las opciones de ordenación disponibles al solicitar una lista de objetos de respuesta.

Valor Description
asc

Especifica un criterio de ordenación ascendente.
desc

Especifica un criterio de ordenación descendente.