Uses of Class
com.azure.ai.agents.persistent.models.CreateRunOptions
Packages that use CreateRunOptions
Package
Description
Package containing the classes for Agents.
Package containing the data models for Agents.
-
Uses of CreateRunOptions in com.azure.ai.agents.persistent
Methods in com.azure.ai.agents.persistent with parameters of type CreateRunOptionsModifier and TypeMethodDescriptionRunsAsyncClient.createRun(CreateRunOptions options) Creates a new run for an agent thread.RunsClient.createRun(CreateRunOptions options) Creates a new run for an agent thread.RunsAsyncClient.createRunStreaming(CreateRunOptions options) Creates a new streaming run for an agent thread.RunsClient.createRunStreaming(CreateRunOptions options) Creates a new streaming run for an agent thread. -
Uses of CreateRunOptions in com.azure.ai.agents.persistent.models
Methods in com.azure.ai.agents.persistent.models that return CreateRunOptionsModifier and TypeMethodDescriptionCreateRunOptions.setAdditionalInstructions(String additionalInstructions) Set the additionalInstructions property: Additional instructions to append at the end of the instructions for the run.CreateRunOptions.setAdditionalMessages(List<ThreadMessageOptions> additionalMessages) Set the additionalMessages property: Adds additional messages to the thread before creating the run.CreateRunOptions.setInclude(List<RunAdditionalFieldList> include) Set the include property: A list of additional fields to include in the response.CreateRunOptions.setInstructions(String instructions) Set the instructions property: The overridden system instructions that the agent should use to run the thread.CreateRunOptions.setMaxCompletionTokens(Integer maxCompletionTokens) Set the maxCompletionTokens property: The maximum number of completion tokens that may be used over the course of the run.CreateRunOptions.setMaxPromptTokens(Integer maxPromptTokens) Set the maxPromptTokens property: The maximum number of prompt tokens that may be used over the course of the run.CreateRunOptions.setMetadata(Map<String, String> metadata) Set the metadata property: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format.Set the model property: The overridden model name that the agent should use to run the thread.CreateRunOptions.setParallelToolCalls(Boolean parallelToolCalls) Set the parallelToolCalls property: If `true` functions will run in parallel during tool use.CreateRunOptions.setResponseFormat(com.azure.core.util.BinaryData responseFormat) Set the responseFormat property: Specifies the format that the model must output.Set the stream property: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.CreateRunOptions.setTemperature(Double temperature) Set the temperature property: What sampling temperature to use, between 0 and 2.CreateRunOptions.setToolChoice(com.azure.core.util.BinaryData toolChoice) Set the toolChoice property: Controls whether or not and which tool is called by the model.CreateRunOptions.setTools(List<ToolDefinition> tools) Set the tools property: The overridden list of enabled tools that the agent should use to run the thread.Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.CreateRunOptions.setTruncationStrategy(TruncationObject truncationStrategy) Set the truncationStrategy property: The strategy to use for dropping messages as the context windows moves forward.