Megosztás:

List Agents - List Agents

Szolgáltatás:
AI Foundry
API-verzió:
v1

Lekéri a korábban létrehozott ügynökök listáját.

GET {endpoint}/assistants?api-version=v1
Opcionális paraméterekkel: 
GET {endpoint}/assistants?api-version=v1&limit={limit}&order={order}&after={after}&before={before}

URI-paraméterek

Name In Kötelező Típus Description
endpoint
 path True

string (uri)

Projektvégpont a következő formában: https://< aiservices-id.services.ai.azure.com/api/projects/>< project-name>
api-version
 query True

string

minLength: 1

A művelethez használandó API-verzió.
after
 query

string

Kurzor lapozáshoz. után van egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot fogad, obj_foo végződve, a következő hívás az after=obj_foo függvényt is belefoglalhatja a lista következő oldalának lekéréséhez.
before
 query

string

Kurzor lapozáshoz. előtt van egy objektumazonosító, amely meghatározza a helyet a listában. Ha például listakérelmet küld, és 100 objektumot fogad, és obj_foo végződik, a következő hívás a before=obj_foo függvényt is belefoglalhatja a lista előző oldalának lekéréséhez.
limit
 query

integer (int32)

Egy oldalon vissza kell juttatni objektumok számának korlátozása. A korlát 1 és 100 közötti lehet, az alapértelmezett érték pedig 20.
order
 query

ListSortOrder

Rendezze a sorrendet az objektumok created_at időbélyege alapján. asc növekvő sorrendhez és csökkenő sorrendhez.

Válaszok

Name Típus Description
200 OK

A kért ügynökök listája.
Other Status Codes

AgentV1Error

Váratlan hibaválasz.

Biztonság

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

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

Példák

ListAgents_MaximumSet
ListAgents_MinimumSet

ListAgents_MaximumSet

Mintakérelem

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

Mintaválasz

Állapotkód:
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": 1.4,
      "top_p": 0.9,
      "metadata": {
        "key6403": "cafmabfintoktvmzcbkzrimxe"
      }
    }
  ],
  "last_id": "egzokahnspv",
  "has_more": true
}

ListAgents_MinimumSet

Mintakérelem

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

Mintaválasz

Állapotkód:
200 
{
  "data": [
    {
      "id": "ldgcuidjvzrp",
      "object": "assistant",
      "created_at": 1,
      "name": "mldxpytbtdtrukktpciqtkcttk",
      "description": "qvci",
      "model": "farpqexpvlgrwtjwawkbryjrxmt",
      "instructions": "csqxezmbgdisjpndkhvxbrbwpeftb",
      "tools": [
        {
          "type": "ToolDefinition"
        }
      ],
      "tool_resources": {},
      "temperature": 1.4,
      "top_p": 0.9,
      "metadata": {}
    }
  ],
  "has_more": true
}

Definíciók

Name Description
AgentErrorDetail

Az ügynök API által visszaadott hibainformációkat ismerteti.
AgentV1Error

Az ügynök API által visszaadott hiba hasznos adat.
ListSortOrder

A válaszobjektumok listájának lekérésekor rendelkezésre álló rendezési lehetőségek.

AgentErrorDetail

Tárgy

Az ügynök API által visszaadott hibainformációkat ismerteti.

Name Típus Description
code

string

Géppel olvasható hibakód.
message

string

A hiba ember által olvasható leírása.
param

string

A hibát okozó paraméter neve, ha van ilyen.
type

string

Hibatípus azonosítója (pl. invalid_request_error).

AgentV1Error

Tárgy

Az ügynök API által visszaadott hiba hasznos adat.

Name Típus Description
error

AgentErrorDetail

A hibát jelöli.

ListSortOrder

Felsorolás

A válaszobjektumok listájának lekérésekor rendelkezésre álló rendezési lehetőségek.

Érték Description
asc

Növekvő rendezési sorrendet ad meg.
desc

Csökkenő rendezési sorrendet ad meg.