Messages - List Messages

Szolgáltatás:

AI Foundry

API-verzió:

v1

Lekéri a szálon található üzenetek listáját.

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

Opcionális paraméterekkel:

GET {endpoint}/threads/{threadId}/messages?run_id={run_id}&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>
threadId	path	True	string	A szál azonosítója.
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.
run_id	query		string	Szűrje az üzeneteket a létrehozott futtatási azonosító alapján.

Válaszok

Name	Típus	Description
200 OK		Az üzenetek kért listája.

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

Messages_ListMessages_MaximumSet

Messages_ListMessages_MinimumSet

Messages_ListMessages_MaximumSet

Mintakérelem

HTTP

GET {endpoint}/threads/xfspsclbezumtyhgjiilvfgivopb/messages?run_id=iyf&api-version=v1&limit=9&order=asc&after=crhyvmyq&before=rmgkbncyohvmwjddfpdomeyxah

Mintaválasz

Állapotkód:

200

{
  "data": [
    {
      "id": "ohzuqfhaw",
      "object": "thread.message",
      "created_at": 11,
      "thread_id": "hcxrpklwbljjfhkywtctg",
      "status": "in_progress",
      "incomplete_details": {
        "reason": "content_filter"
      },
      "completed_at": 8,
      "incomplete_at": 18,
      "role": "user",
      "content": [
        {
          "type": "MessageContent"
        }
      ],
      "assistant_id": "zpujvcgjicl",
      "run_id": "uwsiihbsvcwwncfprmwjzzixsd",
      "attachments": [
        {
          "file_id": "xidx",
          "data_source": {
            "uri": "jtookuzhwojyylbips",
            "type": "uri_asset"
          },
          "tools": [
            null
          ]
        }
      ],
      "metadata": {
        "key9075": "lsmd"
      }
    }
  ],
  "last_id": "vrutbusfuh",
  "has_more": true
}

Messages_ListMessages_MinimumSet

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

{
  "data": [
    {
      "id": "ohzuqfhaw",
      "object": "thread.message",
      "created_at": 11,
      "thread_id": "hcxrpklwbljjfhkywtctg",
      "status": "in_progress",
      "incomplete_details": {
        "reason": "content_filter"
      },
      "completed_at": 8,
      "incomplete_at": 18,
      "role": "user",
      "content": [
        {
          "type": "MessageContent"
        }
      ],
      "assistant_id": "zpujvcgjicl",
      "run_id": "uwsiihbsvcwwncfprmwjzzixsd",
      "attachments": [
        {
          "tools": [
            null
          ]
        }
      ],
      "metadata": {}
    }
  ],
  "has_more": true
}

Definíciók

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.