Run Steps - Get Run Step

Service:

AI Foundry

API-versie:

v1

Hiermee haalt u één uitvoeringsstap op uit een threaduitvoering.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Eindpunt van het project in de vorm van: https://.services.ai.azure.com/api/projects/
runId	path	True	string	Identificatie van de run.
stepId	path	True	string	Identificatie van de uitvoeringsstap.
threadId	path	True	string	Identificatie van de thread.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
include[]	query		RunAdditionalFieldList[]	Een lijst met extra velden die moeten worden opgenomen in het antwoord. Momenteel is step_details.tool_calls[*].file_search.results[*].content de enige ondersteunde waarde om de inhoud van het zoekresultaat van het bestand op te halen.

Antwoorden

Name	Type	Description
200 OK	RunStep	De aanvraag is voltooid.
Other Status Codes	AgentV1Error	Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

RunSteps_GetRunStep_MaximumSet

RunSteps_GetRunStep_MinimumSet

RunSteps_GetRunStep_MaximumSet

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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": {}
}

Definities

Name	Description
AgentErrorDetail	Beschrijft de foutinformatie die wordt geretourneerd door de agents-API.
AgentV1Error	Fout-payload geretourneerd door de agents-API.
FileSearchRankingOptions	Classificatieopties voor het zoeken naar bestanden.
FileSearchToolCallContent	Het inhoudsobject voor het zoekresultaat van het bestand.
RunAdditionalFieldList	Een lijst met extra velden die moeten worden opgenomen in het antwoord.
RunStep	Gedetailleerde informatie over één stap van een agentthreaduitvoering.
RunStepAzureAISearchToolCall	Een record van een aanroep naar een Azure AI Search-hulpprogramma dat is uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma dat de uitgevoerde Azure AI-zoekopdracht vertegenwoordigt.
RunStepBingGroundingToolCall	Een record van een aanroep naar een bing-grounding-hulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat een uitgevoerde zoekopdracht vertegenwoordigt met bing grounding.
RunStepCodeInterpreterImageOutput	Een weergave van een afbeeldingsuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.
RunStepCodeInterpreterImageReference	Een afbeeldingsverwijzing die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep van het hulpprogramma door het model.
RunStepCodeInterpreterLogOutput	Een weergave van een logboekuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.
RunStepCodeInterpreterToolCall	Een record van een aanroep naar een code-interpreter-hulpprogramma dat is uitgegeven door het model tijdens de evaluatie van een gedefinieerd hulpprogramma, dat invoer en uitvoer vertegenwoordigt die worden verbruikt en verzonden door de code-interpreter.
RunStepCodeInterpreterToolCallDetails	De gedetailleerde informatie over het aanroepen van een code-interpreter door het model.
RunStepCompletionUsage	Gebruiksstatistieken met betrekking tot de uitvoeringsstap.
RunStepError	De foutinformatie die is gekoppeld aan een mislukte uitvoeringsstap.
RunStepErrorCode	Mogelijke foutcodewaarden die kunnen worden toegeschreven aan een mislukte uitvoeringsstap.
RunStepFileSearchToolCall	Een record van een aanroep naar een hulpprogramma voor het zoeken van bestanden, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat staat voor uitgevoerde bestandszoekopdrachten.
RunStepFileSearchToolCallResult	Resultaat van het aanroepen van het hulpprogramma voor het zoeken van bestanden.
RunStepFileSearchToolCallResults	De resultaten van het zoeken naar bestanden.
RunStepFunctionToolCall	Een record van een aanroep naar een functiehulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat de verbruikte invoer en uitvoer vertegenwoordigt en die door de opgegeven functie wordt verzonden.
RunStepFunctionToolCallDetails	De gedetailleerde informatie over de functie die door het model wordt aangeroepen.
RunStepMessageCreationDetails	De gedetailleerde informatie die is gekoppeld aan een stap voor het maken van een bericht.
RunStepMessageCreationReference	De details van een bericht dat is gemaakt als onderdeel van een uitvoeringsstap.
RunStepOpenAPIToolCall	Een record van een aanroep naar een OpenAPI-tool, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat uitgevoerde OpenAPI-bewerkingen vertegenwoordigt.
RunStepStatus	Mogelijke waarden voor de status van een uitvoeringsstap.
RunStepToolCallDetails	De gedetailleerde informatie die is gekoppeld aan een hulpprogramma voor het aanroepen van een uitvoeringsstap.
RunStepType	De mogelijke soorten loopstappen.

AgentErrorDetail

Object

Beschrijft de foutinformatie die wordt geretourneerd door de agents-API.

Name	Type	Description
code	string	Machinaal leesbare foutcode.
message	string	Voor mensen leesbare beschrijving van de fout.
param	string	Naam van de parameter die de fout heeft veroorzaakt, indien van toepassing.
type	string	Identificatie van het fouttype (bijv. invalid_request_error).

AgentV1Error

Object

Fout-payload geretourneerd door de agents-API.

Name	Type	Description
error	AgentErrorDetail	Vertegenwoordigt de fout.

FileSearchRankingOptions

Object

Classificatieopties voor het zoeken naar bestanden.

Name	Type	Description
ranker	string	Ranker voor het zoeken van bestanden.
score_threshold	number (float)	Zoekdrempel voor rangschikking.

FileSearchToolCallContent

Object

Het inhoudsobject voor het zoekresultaat van het bestand.

Name	Type	Description
text	string	De tekstinhoud van het bestand.
type	enum: text	Het type inhoud.

RunAdditionalFieldList

Inventarisatie

Een lijst met extra velden die moeten worden opgenomen in het antwoord.

Waarde	Description
step_details.tool_calls[*].file_search.results[*].content	Inhoud van zoekresultaten voor bestanden.

RunStep

Object

Gedetailleerde informatie over één stap van een agentthreaduitvoering.

Name	Type	Description
assistant_id	string	De id van de agent die is gekoppeld aan de uitvoeringsstap.
cancelled_at	integer (unixtime)	De Unix-tijdstempel, in seconden, die aangeeft wanneer dit is geannuleerd.
completed_at	integer (unixtime)	De Unix-tijdstempel, in seconden, die aangeeft wanneer dit is voltooid.
created_at	integer (unixtime)	De Unix-tijdstempel, in seconden, die aangeeft wanneer dit object is gemaakt.
expired_at	integer (unixtime)	De Unix-tijdstempel, in seconden, die aangeeft wanneer dit item is verlopen.
failed_at	integer (unixtime)	De Unix-tijdstempel, in seconden, die aangeeft wanneer dit is mislukt.
id	string	De id waarnaar kan worden verwezen in API-eindpunten.
last_error	RunStepError	Indien van toepassing, informatie over de laatste fout die is opgetreden tijdens deze uitvoeringsstap.
metadata	object	Een set van maximaal 16 sleutel-/waardeparen die aan een object kunnen worden gekoppeld, die wordt gebruikt voor het opslaan van aanvullende informatie over dat object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
object	enum: thread.run.step	Het objecttype, dat altijd thread.run.step is.
run_id	string	De id van de uitvoering waarvan deze uitvoeringsstap deel uitmaakt.
status	RunStepStatus	De status van deze uitvoeringsstap.
step_details	RunStepDetails: RunStepMessageCreationDetails RunStepToolCallDetails	De details voor deze uitvoeringsstap.
thread_id	string	De id van de thread die is uitgevoerd.
type	RunStepType	Het type uitvoeringsstap, dat kan message_creation of tool_calls zijn.
usage	RunStepCompletionUsage	Gebruiksstatistieken met betrekking tot de uitvoeringsstap. Deze waarde is null zolang de status van de uitvoeringsstap is in_progress.

RunStepAzureAISearchToolCall

Object

Een record van een aanroep naar een Azure AI Search-hulpprogramma dat is uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma dat de uitgevoerde Azure AI-zoekopdracht vertegenwoordigt.

Name	Type	Description
azure_ai_search	object	Gereserveerd voor toekomstig gebruik.
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
type	string: azure_ai_search	Het objecttype.

RunStepBingGroundingToolCall

Object

Een record van een aanroep naar een bing-grounding-hulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat een uitgevoerde zoekopdracht vertegenwoordigt met bing grounding.

Name	Type	Description
bing_grounding	object	Gereserveerd voor toekomstig gebruik.
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
type	string: bing_grounding	Het objecttype.

RunStepCodeInterpreterImageOutput

Object

Een weergave van een afbeeldingsuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.

Name	Type	Description
image	RunStepCodeInterpreterImageReference	Referentiële informatie voor de afbeelding die aan deze uitvoer is gekoppeld.
type	string: image	Het objecttype.

RunStepCodeInterpreterImageReference

Object

Een afbeeldingsverwijzing die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een aanroep van het hulpprogramma door het model.

Name	Type	Description
file_id	string	De id van het bestand dat aan deze afbeelding is gekoppeld.

RunStepCodeInterpreterLogOutput

Object

Een weergave van een logboekuitvoer die wordt verzonden door een code-interpreter-hulpprogramma als reactie op een door het model aanroep van een hulpprogramma.

Name	Type	Description
logs	string	De geserialiseerde logboekuitvoer die wordt verzonden door de code-interpreter.
type	string: logs	Het objecttype.

RunStepCodeInterpreterToolCall

Object

Een record van een aanroep naar een code-interpreter-hulpprogramma dat is uitgegeven door het model tijdens de evaluatie van een gedefinieerd hulpprogramma, dat invoer en uitvoer vertegenwoordigt die worden verbruikt en verzonden door de code-interpreter.

Name	Type	Description
code_interpreter	RunStepCodeInterpreterToolCallDetails	De details van de aanroep van het hulpprogramma voor de code-interpreter.
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
type	string: code_interpreter	Het objecttype.

RunStepCodeInterpreterToolCallDetails

Object

De gedetailleerde informatie over het aanroepen van een code-interpreter door het model.

Name	Type	Description
input	string	De invoer die door het model wordt geleverd aan het code-interpreter-hulpprogramma.
outputs	RunStepCodeInterpreterToolCallOutput[]: RunStepCodeInterpreterImageOutput[] RunStepCodeInterpreterLogOutput[]	De uitvoer die door het code-interpreter-hulpprogramma wordt geproduceerd, wordt teruggezet naar het model als reactie op de aanroep van het hulpprogramma.

RunStepCompletionUsage

Object

Gebruiksstatistieken met betrekking tot de uitvoeringsstap.

Name	Type	Description
completion_tokens	integer (int64)	Het aantal voltooiingstokens dat in de loop van de uitvoeringsstap wordt gebruikt.
prompt_tokens	integer (int64)	Het aantal prompttokens dat wordt gebruikt tijdens de uitvoeringsstap.
total_tokens	integer (int64)	Totaal aantal gebruikte tokens (prompt + voltooiing).

RunStepError

Object

De foutinformatie die is gekoppeld aan een mislukte uitvoeringsstap.

Name	Type	Description
code	RunStepErrorCode	De foutcode voor deze fout.
message	string	De door mensen leesbare tekst die aan deze fout is gekoppeld.

RunStepErrorCode

Inventarisatie

Mogelijke foutcodewaarden die kunnen worden toegeschreven aan een mislukte uitvoeringsstap.

Waarde	Description
rate_limit_exceeded	Vertegenwoordigt een fout die aangeeft dat de geconfigureerde snelheidslimieten zijn overschreden.
server_error	Vertegenwoordigt een serverfout.

RunStepFileSearchToolCall

Object

Een record van een aanroep naar een hulpprogramma voor het zoeken van bestanden, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat staat voor uitgevoerde bestandszoekopdrachten.

Name	Type	Description
file_search	RunStepFileSearchToolCallResults	Op dit moment is dit altijd een leeg object.
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
type	string: file_search	Het objecttype.

RunStepFileSearchToolCallResult

Object

Resultaat van het aanroepen van het hulpprogramma voor het zoeken van bestanden.

Name	Type	Description
content	FileSearchToolCallContent[]	De inhoud van het resultaat dat is gevonden. De inhoud wordt alleen opgenomen als deze wordt aangevraagd via de queryparameter opnemen.
file_id	string	De id van het bestand waarin het resultaat is gevonden.
file_name	string	De naam van het bestand waarin het resultaat is gevonden.
score	number (float) minimum: 0 maximum: 1	De score van het resultaat. Alle waarden moeten een drijvendekommagetal tussen 0 en 1 zijn.

RunStepFileSearchToolCallResults

Object

De resultaten van het zoeken naar bestanden.

Name	Type	Description
ranking_options	FileSearchRankingOptions	Classificatieopties voor het zoeken naar bestanden.
results	RunStepFileSearchToolCallResult[]	De matrix van de zoekresultaten van een bestand

RunStepFunctionToolCall

Object

Een record van een aanroep naar een functiehulpprogramma, uitgegeven door het model in evaluatie van een gedefinieerd hulpprogramma, dat de verbruikte invoer en uitvoer vertegenwoordigt en die door de opgegeven functie wordt verzonden.

Name	Type	Description
function	RunStepFunctionToolCallDetails	De gedetailleerde informatie over de functie die door het model wordt aangeroepen.
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
type	string: function	Het objecttype.

RunStepFunctionToolCallDetails

Object

De gedetailleerde informatie over de functie die door het model wordt aangeroepen.

Name	Type	Description
arguments	string	De argumenten die het model nodig heeft, worden geleverd aan de benoemde functie.
name	string	De naam van de functie.

RunStepMessageCreationDetails

Object

De gedetailleerde informatie die is gekoppeld aan een stap voor het maken van een bericht.

Name	Type	Description
message_creation	RunStepMessageCreationReference	Informatie over het maken van berichten die zijn gekoppeld aan deze uitvoeringsstap.
type	string: message_creation	Het objecttype.

RunStepMessageCreationReference

Object

De details van een bericht dat is gemaakt als onderdeel van een uitvoeringsstap.

Name	Type	Description
message_id	string	De id van het bericht dat door deze uitvoerstap is gemaakt.

RunStepOpenAPIToolCall

Object

Een record van een aanroep naar een OpenAPI-tool, uitgegeven door het model ter evaluatie van een gedefinieerd hulpprogramma, dat uitgevoerde OpenAPI-bewerkingen vertegenwoordigt.

Name	Type	Description
id	string	De id van de aanroep van het hulpprogramma. Er moet naar deze id worden verwezen wanneer u uitvoer van het hulpprogramma verzendt.
openapi	object	Gereserveerd voor toekomstig gebruik.
type	string: openapi	Het objecttype.

RunStepStatus

Inventarisatie

Mogelijke waarden voor de status van een uitvoeringsstap.

Waarde	Description
cancelled	Vertegenwoordigt een run-stap die is geannuleerd.
completed	Vertegenwoordigt een uitvoeringsstap die met succes is voltooid.
expired	Vertegenwoordigt een uitvoeringsstap die is verlopen voordat deze op een andere manier is voltooid.
failed	Vertegenwoordigt een uitvoeringsstap die is mislukt.
in_progress	Vertegenwoordigt een lopende stap die nog aan de gang is.

RunStepToolCallDetails

Object

De gedetailleerde informatie die is gekoppeld aan een hulpprogramma voor het aanroepen van een uitvoeringsstap.

Name	Type	Description
tool_calls	RunStepToolCall[]: RunStepAzureAISearchToolCall[] RunStepBingGroundingToolCall[] RunStepCodeInterpreterToolCall[] RunStepFileSearchToolCall[] RunStepFunctionToolCall[] RunStepOpenAPIToolCall[]	Een lijst met aanroepdetails van het hulpprogramma voor deze uitvoeringsstap.
type	string: tool_calls	Het objecttype.

RunStepType

Inventarisatie

De mogelijke soorten loopstappen.

Waarde	Description
message_creation	Vertegenwoordigt een uitvoerstap om een bericht te maken.
tool_calls	Vertegenwoordigt een uitvoeringsstap die hulpprogramma's aanroept.