次の方法で共有

PersistentAgent Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2
  • java.lang.Object
    • com.azure.ai.agents.persistent.models.PersistentAgent

Implements

JsonSerializable<PersistentAgent>

public final class PersistentAgent
implements JsonSerializable<PersistentAgent>

Represents an agent that can call the model and use tools.

Method Summary

Modifier and Type Method and Description
static PersistentAgent fromJson(JsonReader jsonReader)

Reads an instance of PersistentAgent from the JsonReader.
OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
String getDescription()

Get the description property: The description of the agent.
String getId()

Get the id property: The identifier, which can be referenced in API endpoints.
String getInstructions()

Get the instructions property: The system instructions for the agent to use.
Map<String,String> getMetadata()

Get 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.
String getModel()

Get the model property: The ID of the model to use.
String getName()

Get the name property: The name of the agent.
String getObject()

Get the object property: The object type, which is always assistant.
BinaryData getResponseFormat()

Get the responseFormat property: The response format of the tool calls used by this agent.
Double getTemperature()

Get the temperature property: What sampling temperature to use, between 0 and 2.
ToolResources getToolResources()

Get the toolResources property: A set of resources that are used by the agent's tools.
List<ToolDefinition> getTools()

Get the tools property: The collection of tools enabled for the agent.
Double getTopP()

Get 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.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static PersistentAgent fromJson(JsonReader jsonReader)

Reads an instance of PersistentAgent from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PersistentAgent if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.

Returns:

the createdAt value.

getDescription

public String getDescription()

Get the description property: The description of the agent.

Returns:

the description value.

getId

public String getId()

Get the id property: The identifier, which can be referenced in API endpoints.

Returns:

the id value.

getInstructions

public String getInstructions()

Get the instructions property: The system instructions for the agent to use.

Returns:

the instructions value.

getMetadata

public Map<String,String> getMetadata()

Get 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. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Returns:

the metadata value.

getModel

public String getModel()

Get the model property: The ID of the model to use.

Returns:

the model value.

getName

public String getName()

Get the name property: The name of the agent.

Returns:

the name value.

getObject

public String getObject()

Get the object property: The object type, which is always assistant.

Returns:

the object value.

getResponseFormat

public BinaryData getResponseFormat()

Get the responseFormat property: The response format of the tool calls used by this agent.

Returns:

the responseFormat value.

getTemperature

public Double getTemperature()

Get the temperature property: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

Returns:

the temperature value.

getToolResources

public ToolResources getToolResources()

Get the toolResources property: A set of resources that are used by the agent's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.

Returns:

the toolResources value.

getTools

public List<ToolDefinition> getTools()

Get the tools property: The collection of tools enabled for the agent.

Returns:

the tools value.

getTopP

public Double getTopP()

Get 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. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

Returns:

the topP value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to