Compartilhar via

Messages - List Messages

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

Obtém uma lista de mensagens que existem em um thread.

GET {endpoint}/threads/{threadId}/messages?api-version=v1
Com parâmetros opcionais: 
GET {endpoint}/threads/{threadId}/messages?run_id={run_id}&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/
threadId
 path True

string

Identificador do thread.
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.
run_id
 query

string

Filtre mensagens pela ID de execução que as gerou.

Respostas

Nome Tipo Description
200 OK

A lista de mensagens solicitadas.

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

Messages_ListMessages_MaximumSet
Messages_ListMessages_MinimumSet

Messages_ListMessages_MaximumSet

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

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.