Run Steps - Get Run Step

Referência

Serviço:: AI Foundry

Versão da API:: v1

Recupera uma única etapa de execução de uma execução de thread.

GET {endpoint}/threads/{threadId}/runs/{runId}/steps/{stepId}?api-version=v1

Com parâmetros opcionais:

GET {endpoint}/threads/{threadId}/runs/{runId}/steps/{stepId}?api-version=v1&include[]=step_details.tool_calls[*].file_search.results[*].content

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	Ponto final do projeto na forma de: https://.services.ai.azure.com/api/projects/
runId	path	True	string	Identificador da execução.
stepId	path	True	string	Identificador da etapa de execução.
threadId	path	True	string	Identificador do thread.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
include[]	query		RunAdditionalFieldList[]	Uma lista de campos adicionais a incluir na resposta. Atualmente, o único valor suportado é `step_details.tool_calls[].file_search.results[].content` para buscar o conteúdo do resultado da pesquisa de arquivos.

Respostas

Name	Tipo	Description
200 OK	RunStep	O pedido foi bem-sucedido.
Other Status Codes	AgentV1Error	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

RunSteps_GetRunStep_MaximumSet

RunSteps_GetRunStep_MinimumSet

RunSteps_GetRunStep_MaximumSet

Pedido de amostra

HTTP

GET {endpoint}/threads/aoggpmegxxetkrqduh/runs/uqnfokuxdhxswsesez/steps/cgsrveuovjblcuufiwizraimccdulv?api-version=v1&include[]=step_details.tool_calls[*].file_search.results[*].content

Resposta da amostra

Código de estado:: 200

{
  "id": "nhpyvcnwelbeqdikrscpuy",
  "object": "thread.run.step",
  "type": "message_creation",
  "assistant_id": "qfrqthdxqbpdmef",
  "thread_id": "elbgkzzqjitqgthuoofxgolm",
  "run_id": "ewtgzwjmuhzbxftergmc",
  "status": "in_progress",
  "step_details": {
    "type": "RunStepDetails"
  },
  "last_error": {
    "code": "server_error",
    "message": "eesagbdshoe"
  },
  "created_at": 26,
  "expired_at": 4,
  "completed_at": 9,
  "cancelled_at": 26,
  "failed_at": 16,
  "usage": {
    "completion_tokens": 16,
    "prompt_tokens": 5,
    "total_tokens": 14
  },
  "metadata": {
    "key5385": "itegidvmkp"
  }
}

RunSteps_GetRunStep_MinimumSet

Pedido de amostra

HTTP

GET {endpoint}/threads/oyojcyebnp/runs/icgosawqdckxggmqb/steps/blaqrlzeqaxeusghhfwvktk?api-version=v1&include[]=step_details.tool_calls[*].file_search.results[*].content

Resposta da amostra

Código de estado:: 200

{
  "id": "nhpyvcnwelbeqdikrscpuy",
  "object": "thread.run.step",
  "type": "message_creation",
  "assistant_id": "qfrqthdxqbpdmef",
  "thread_id": "elbgkzzqjitqgthuoofxgolm",
  "run_id": "ewtgzwjmuhzbxftergmc",
  "status": "in_progress",
  "step_details": {
    "type": "RunStepDetails"
  },
  "last_error": {
    "code": "server_error",
    "message": "eesagbdshoe"
  },
  "created_at": 26,
  "expired_at": 4,
  "completed_at": 9,
  "cancelled_at": 26,
  "failed_at": 16,
  "metadata": {}
}

Definições

Name	Description
AgentErrorDetail	Descreve as informações de erro retornadas pela API dos agentes.
AgentV1Error	Erro de carga retornada pela API dos agentes.
FileSearchRankingOptions	Opções de classificação para pesquisa de ficheiros.
FileSearchToolCallContent	O objeto de conteúdo do resultado da pesquisa de arquivo.
RunAdditionalFieldList	Uma lista de campos adicionais a incluir na resposta.
RunStep	Informações detalhadas sobre uma única etapa de uma execução de thread de agente.
RunStepAzureAISearchToolCall	Um registro de uma chamada para uma ferramenta de Pesquisa de IA do Azure, emitida pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa de IA do Azure executada.
RunStepBingGroundingToolCall	Um registro de uma chamada para uma ferramenta de aterramento do Bing, emitido pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa executada com o aterramento do Bing.
RunStepCodeInterpreterImageOutput	Uma representação de uma saída de imagem emitida por uma ferramenta interpretadora de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterImageReference	Uma referência de imagem emitida por uma ferramenta interpretadora de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterLogOutput	Uma representação de uma saída de log emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo.
RunStepCodeInterpreterToolCall	Um registro de uma chamada para uma ferramenta interpretadora de código, emitida pelo modelo em avaliação de uma ferramenta definida, que representa entradas e saídas consumidas e emitidas pelo interpretador de código.
RunStepCodeInterpreterToolCallDetails	As informações detalhadas sobre uma invocação do interpretador de código pelo modelo.
RunStepCompletionUsage	Estatísticas de uso relacionadas à etapa de execução.
RunStepError	As informações de erro associadas a uma etapa de execução com falha.
RunStepErrorCode	Possíveis valores de código de erro atribuíveis a uma etapa de execução com falha.
RunStepFileSearchToolCall	Um registro de uma chamada para uma ferramenta de pesquisa de arquivos, emitida pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa de arquivos executada.
RunStepFileSearchToolCallResult	Resultado da chamada da ferramenta de pesquisa de ficheiros.
RunStepFileSearchToolCallResults	Os resultados da pesquisa de ficheiros.
RunStepFunctionToolCall	Um registro de uma chamada para uma ferramenta de função, emitido pelo modelo em avaliação de uma ferramenta definida, que representa as entradas e saídas consumidas e emitidas pela função especificada.
RunStepFunctionToolCallDetails	As informações detalhadas sobre a função chamada pelo modelo.
RunStepMessageCreationDetails	As informações detalhadas associadas a uma etapa de execução de criação de mensagem.
RunStepMessageCreationReference	Os detalhes de uma mensagem criada como parte de uma etapa de execução.
RunStepOpenAPIToolCall	Um registro de uma chamada para uma ferramenta OpenAPI, emitido pelo modelo em avaliação de uma ferramenta definida, que representa operações OpenAPI executadas.
RunStepStatus	Valores possíveis para o status de uma etapa de execução.
RunStepToolCallDetails	As informações detalhadas associadas a uma ferramenta de chamada de etapa de execução.
RunStepType	Os possíveis tipos de etapas de execução.

AgentErrorDetail

Object

Descreve as informações de erro retornadas pela API dos agentes.

Name	Tipo	Description
code	string	Código de erro legível por máquina.
message	string	Descrição do erro legível por humanos.
param	string	Nome do parâmetro que causou o erro, se aplicável.
type	string	Identificador do tipo de erro (por exemplo, `invalid_request_error`).

AgentV1Error

Object

Erro de carga retornada pela API dos agentes.

Name	Tipo	Description
error	AgentErrorDetail	Representa o erro.

FileSearchRankingOptions

Object

Opções de classificação para pesquisa de ficheiros.

Name	Tipo	Description
ranker	string	Classificador de pesquisa de ficheiros.
score_threshold	number (float)	Limiar de pesquisa do classificador.

FileSearchToolCallContent

Object

O objeto de conteúdo do resultado da pesquisa de arquivo.

Name	Tipo	Description
text	string	O conteúdo de texto do arquivo.
type	enum: text	O tipo de conteúdo.

RunAdditionalFieldList

Enumeração

Uma lista de campos adicionais a incluir na resposta.

Valor	Description
step_details.tool_calls[].file_search.results[].content	Conteúdo do resultado da pesquisa de ficheiros.

RunStep

Object

Informações detalhadas sobre uma única etapa de uma execução de thread de agente.

Name	Tipo	Description
assistant_id	string	A ID do agente associado à etapa de execução.
cancelled_at	integer (unixtime)	O carimbo de data/hora Unix, em segundos, representando quando isso foi cancelado.
completed_at	integer (unixtime)	O carimbo de data/hora Unix, em segundos, representando quando isso foi concluído.
created_at	integer (unixtime)	O carimbo de data/hora Unix, em segundos, representando quando este objeto foi criado.
expired_at	integer (unixtime)	O carimbo de data/hora Unix, em segundos, representando quando este item expirou.
failed_at	integer (unixtime)	O carimbo de data/hora do Unix, em segundos, representando quando isso falhou.
id	string	O identificador, que pode ser referenciado em pontos de extremidade de API.
last_error	RunStepError	Se aplicável, informações sobre o último erro encontrado por esta etapa de execução.
metadata	object	Um conjunto de até 16 pares chave/valor que podem ser anexados a um objeto, usado para armazenar informações adicionais sobre esse objeto em um formato estruturado. As teclas podem ter até 64 caracteres e os valores podem ter até 512 caracteres.
object	enum: thread.run.step	O tipo de objeto, que é sempre 'thread.run.step'.
run_id	string	A ID da execução da qual esta etapa de execução faz parte.
status	RunStepStatus	O status desta etapa de execução.
step_details	RunStepDetails: RunStepMessageCreationDetails RunStepToolCallDetails	Os detalhes para esta etapa de execução.
thread_id	string	A ID do thread que foi executado.
type	RunStepType	O tipo de etapa de execução, que pode ser message_creation ou tool_calls.
usage	RunStepCompletionUsage	Estatísticas de uso relacionadas à etapa de execução. Esse valor será `null` enquanto o status da etapa de execução for `in_progress`.

RunStepAzureAISearchToolCall

Object

Um registro de uma chamada para uma ferramenta de Pesquisa de IA do Azure, emitida pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa de IA do Azure executada.

Name	Tipo	Description
azure_ai_search	object	Reservado para uso futuro.
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
type	string: azure_ai_search	O tipo de objeto.

RunStepBingGroundingToolCall

Object

Um registro de uma chamada para uma ferramenta de aterramento do Bing, emitido pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa executada com o aterramento do Bing.

Name	Tipo	Description
bing_grounding	object	Reservado para uso futuro.
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
type	string: bing_grounding	O tipo de objeto.

RunStepCodeInterpreterImageOutput

Object

Uma representação de uma saída de imagem emitida por uma ferramenta interpretadora de código em resposta a uma chamada de ferramenta pelo modelo.

Name	Tipo	Description
image	RunStepCodeInterpreterImageReference	Informação referencial para a imagem associada a esta saída.
type	string: image	O tipo de objeto.

RunStepCodeInterpreterImageReference

Object

Uma referência de imagem emitida por uma ferramenta interpretadora de código em resposta a uma chamada de ferramenta pelo modelo.

Name	Tipo	Description
file_id	string	O ID do ficheiro associado a esta imagem.

RunStepCodeInterpreterLogOutput

Object

Uma representação de uma saída de log emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo.

Name	Tipo	Description
logs	string	A saída de log serializada emitida pelo interpretador de código.
type	string: logs	O tipo de objeto.

RunStepCodeInterpreterToolCall

Object

Um registro de uma chamada para uma ferramenta interpretadora de código, emitida pelo modelo em avaliação de uma ferramenta definida, que representa entradas e saídas consumidas e emitidas pelo interpretador de código.

Name	Tipo	Description
code_interpreter	RunStepCodeInterpreterToolCallDetails	Os detalhes da ferramenta chamam para a ferramenta interpretadora de código.
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
type	string: code_interpreter	O tipo de objeto.

RunStepCodeInterpreterToolCallDetails

Object

As informações detalhadas sobre uma invocação do interpretador de código pelo modelo.

Name	Tipo	Description
input	string	A entrada fornecida pelo modelo para a ferramenta de interpretador de código.
outputs	RunStepCodeInterpreterToolCallOutput[]: RunStepCodeInterpreterImageOutput[] RunStepCodeInterpreterLogOutput[]	As saídas produzidas pela ferramenta interpretadora de código voltam para o modelo em resposta à chamada da ferramenta.

RunStepCompletionUsage

Object

Estatísticas de uso relacionadas à etapa de execução.

Name	Tipo	Description
completion_tokens	integer (int64)	Número de tokens de conclusão usados ao longo da etapa de execução.
prompt_tokens	integer (int64)	Número de tokens de prompt usados ao longo da etapa de execução.
total_tokens	integer (int64)	Número total de tokens usados (prompt + conclusão).

RunStepError

Object

As informações de erro associadas a uma etapa de execução com falha.

Name	Tipo	Description
code	RunStepErrorCode	O código de erro para este erro.
message	string	O texto legível por humanos associado a este erro.

RunStepErrorCode

Enumeração

Possíveis valores de código de erro atribuíveis a uma etapa de execução com falha.

Valor	Description
rate_limit_exceeded	Representa um erro indicando que os limites de taxa configurados foram excedidos.
server_error	Representa um erro do servidor.

RunStepFileSearchToolCall

Object

Um registro de uma chamada para uma ferramenta de pesquisa de arquivos, emitida pelo modelo em avaliação de uma ferramenta definida, que representa a pesquisa de arquivos executada.

Name	Tipo	Description
file_search	RunStepFileSearchToolCallResults	Por enquanto, este será sempre um objeto vazio.
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
type	string: file_search	O tipo de objeto.

RunStepFileSearchToolCallResult

Object

Resultado da chamada da ferramenta de pesquisa de ficheiros.

Name	Tipo	Description
content	FileSearchToolCallContent[]	O conteúdo do resultado encontrado. O conteúdo só é incluído se solicitado através do parâmetro include query.
file_id	string	A ID do arquivo em que o resultado foi encontrado.
file_name	string	O nome do arquivo em que o resultado foi encontrado.
score	number (float) minimum: 0 maximum: 1	A pontuação do resultado. Todos os valores devem ser um número de ponto flutuante entre 0 e 1.

RunStepFileSearchToolCallResults

Object

Os resultados da pesquisa de ficheiros.

Name	Tipo	Description
ranking_options	FileSearchRankingOptions	Opções de classificação para pesquisa de ficheiros.
results	RunStepFileSearchToolCallResult[]	A matriz dos resultados de uma pesquisa de arquivo

RunStepFunctionToolCall

Object

Um registro de uma chamada para uma ferramenta de função, emitido pelo modelo em avaliação de uma ferramenta definida, que representa as entradas e saídas consumidas e emitidas pela função especificada.

Name	Tipo	Description
function	RunStepFunctionToolCallDetails	As informações detalhadas sobre a função chamada pelo modelo.
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
type	string: function	O tipo de objeto.

RunStepFunctionToolCallDetails

Object

As informações detalhadas sobre a função chamada pelo modelo.

Name	Tipo	Description
arguments	string	Os argumentos que o modelo requer são fornecidos para a função nomeada.
name	string	O nome da função.

RunStepMessageCreationDetails

Object

As informações detalhadas associadas a uma etapa de execução de criação de mensagem.

Name	Tipo	Description
message_creation	RunStepMessageCreationReference	Informações sobre a criação de mensagens associada a esta etapa de execução.
type	string: message_creation	O tipo de objeto.

RunStepMessageCreationReference

Object

Os detalhes de uma mensagem criada como parte de uma etapa de execução.

Name	Tipo	Description
message_id	string	A ID da mensagem criada por esta etapa de execução.

RunStepOpenAPIToolCall

Object

Um registro de uma chamada para uma ferramenta OpenAPI, emitido pelo modelo em avaliação de uma ferramenta definida, que representa operações OpenAPI executadas.

Name	Tipo	Description
id	string	O identificador da chamada da ferramenta. Esse ID deve ser referenciado quando você envia saídas da ferramenta.
openapi	object	Reservado para uso futuro.
type	string: openapi	O tipo de objeto.

RunStepStatus

Enumeração

Valores possíveis para o status de uma etapa de execução.

Valor	Description
cancelled	Representa uma etapa de execução que foi cancelada.
completed	Representa uma etapa de execução concluída com êxito.
expired	Representa uma etapa de execução que expirou antes de terminar.
failed	Representa uma etapa de execução que falhou.
in_progress	Representa uma etapa de execução ainda em andamento.

RunStepToolCallDetails

Object

As informações detalhadas associadas a uma ferramenta de chamada de etapa de execução.

Name	Tipo	Description
tool_calls	RunStepToolCall[]: RunStepAzureAISearchToolCall[] RunStepBingGroundingToolCall[] RunStepCodeInterpreterToolCall[] RunStepFileSearchToolCall[] RunStepFunctionToolCall[] RunStepOpenAPIToolCall[]	Uma lista de detalhes de chamada de ferramenta para esta etapa de execução.
type	string: tool_calls	O tipo de objeto.

RunStepType

Enumeração

Os possíveis tipos de etapas de execução.

Valor	Description
message_creation	Representa uma etapa de execução para criar uma mensagem.
tool_calls	Representa uma etapa de execução que chama ferramentas.

Partilhar via

Run Steps - Get Run Step

Parâmetros do URI

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

RunSteps_GetRunStep_MaximumSet

Pedido de amostra

Resposta da amostra

RunSteps_GetRunStep_MinimumSet

Pedido de amostra

Resposta da amostra

Definições

AgentErrorDetail

AgentV1Error

FileSearchRankingOptions

FileSearchToolCallContent

RunAdditionalFieldList

RunStep

RunStepAzureAISearchToolCall

RunStepBingGroundingToolCall

RunStepCodeInterpreterImageOutput

RunStepCodeInterpreterImageReference

RunStepCodeInterpreterLogOutput

RunStepCodeInterpreterToolCall

RunStepCodeInterpreterToolCallDetails

RunStepCompletionUsage

RunStepError

RunStepErrorCode

RunStepFileSearchToolCall

RunStepFileSearchToolCallResult

RunStepFileSearchToolCallResults

RunStepFunctionToolCall

RunStepFunctionToolCallDetails

RunStepMessageCreationDetails

RunStepMessageCreationReference

RunStepOpenAPIToolCall

RunStepStatus

RunStepToolCallDetails

RunStepType