Freigeben über

List Agents - List Agents

  • Referenz
Dienst:
AI Foundry
API-Version:
v1

Ruft eine Liste der Agents ab, die zuvor erstellt wurden.

GET {endpoint}/assistants?api-version=v1
Mit optionalen Parametern: 
GET {endpoint}/assistants?api-version=v1&limit={limit}&order={order}&after={after}&before={before}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

Projektendpunkt in Form von: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.
after
 query

string

Ein Cursor für die Verwendung in der Paginierung. after ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen und mit obj_foo enden, kann Der nachfolgende Aufruf after=obj_foo enthalten, um die nächste Seite der Liste abzurufen.
before
 query

string

Ein Cursor für die Verwendung in der Paginierung. before ist eine Objekt-ID, die Ihren Platz in der Liste definiert. Wenn Sie z. B. eine Listenanforderung stellen und 100 Objekte empfangen, die mit obj_foo enden, kann Ihr nachfolgender Aufruf before=obj_foo enthalten, um die vorherige Seite der Liste abzurufen.
limit
 query

integer (int32)

Ein Grenzwert für die Anzahl der zurückzugebenden Objekte. Der Grenzwert kann zwischen 1 und 100 liegen, und der Standardwert ist 20.
order
 query

ListSortOrder

Sortierreihenfolge nach dem created_at Zeitstempel der Objekte. asc für aufsteigende Reihenfolge und Desc für absteigende Reihenfolge.

Antworten

Name Typ Beschreibung
200 OK

Die angeforderte Liste der Agenten.
Other Status Codes

AgentV1Error

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

ListAgents_MaximumSet
ListAgents_MinimumSet

ListAgents_MaximumSet

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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
}

Definitionen

Name Beschreibung
AgentErrorDetail

Beschreibt die Fehlerinformationen, die von der Agenten-API zurückgegeben werden.
AgentV1Error

Fehlernutzlast, die von der Agenten-API zurückgegeben wird.
ListSortOrder

Die verfügbaren Sortieroptionen beim Anfordern einer Liste von Antwortobjekten.

AgentErrorDetail

Objekt

Beschreibt die Fehlerinformationen, die von der Agenten-API zurückgegeben werden.

Name Typ Beschreibung
code

string

Maschinenlesbarer Fehlercode.
message

string

Für Menschen lesbare Beschreibung des Fehlers.
param

string

Name des Parameters, der den Fehler verursacht hat, falls zutreffend.
type

string

Kennung des Fehlertyps (z. B. invalid_request_error).

AgentV1Error

Objekt

Fehlernutzlast, die von der Agenten-API zurückgegeben wird.

Name Typ Beschreibung
error

AgentErrorDetail

Stellt den Fehler dar.

ListSortOrder

Enumeration

Die verfügbaren Sortieroptionen beim Anfordern einer Liste von Antwortobjekten.

Wert Beschreibung
asc

Gibt eine aufsteigende Sortierreihenfolge an.
desc

Gibt eine absteigende Sortierreihenfolge an.