CreateAgentVersionInput Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0
  • java.lang.Object
    • com.azure.ai.agents.models.CreateAgentVersionInput

Implements

JsonSerializable<CreateAgentVersionInput>

public final class CreateAgentVersionInput
implements JsonSerializable<CreateAgentVersionInput>

The CreateAgentVersionInput model.

Constructor Summary

Constructor Description
CreateAgentVersionInput(AgentDefinition definition)

Creates an instance of CreateAgentVersionInput class.

Method Summary

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

Reads an instance of CreateAgentVersionInput from the JsonReader.
AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint reference for the agent.
AgentDefinition getDefinition()

Get the definition property: The agent definition.
String getDescription()

Get the description property: A human-readable description of the agent.
Map<String,String> getMetadata()

Get the metadata property: Set of 16 key-value pairs that can be attached to an object.
Boolean isDraft()

Get the draft property: (Preview) Whether this agent version is a draft (candidate) rather than a release.
CreateAgentVersionInput setBlueprintReference(AgentBlueprintReference blueprintReference)

Set the blueprintReference property: The blueprint reference for the agent.
CreateAgentVersionInput setDescription(String description)

Set the description property: A human-readable description of the agent.
CreateAgentVersionInput setDraft(Boolean draft)

Set the draft property: (Preview) Whether this agent version is a draft (candidate) rather than a release.
CreateAgentVersionInput setMetadata(Map<String,String> metadata)

Set the metadata property: Set of 16 key-value pairs that can be attached to an object.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CreateAgentVersionInput

public CreateAgentVersionInput(AgentDefinition definition)

Creates an instance of CreateAgentVersionInput class.

Parameters:

definition - the definition value to set.

Method Details

fromJson

public static CreateAgentVersionInput fromJson(JsonReader jsonReader)

Reads an instance of CreateAgentVersionInput from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CreateAgentVersionInput 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.

getBlueprintReference

public AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint reference for the agent.

Returns:

the blueprintReference value.

getDefinition

public AgentDefinition getDefinition()

Get the definition property: The agent definition. This can be a workflow, hosted agent, or a simple agent definition.

Returns:

the definition value.

getDescription

public String getDescription()

Get the description property: A human-readable description of the agent.

Returns:

the description value.

getMetadata

public Map<String,String> getMetadata()

Get the metadata property: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

the metadata value.

isDraft

public Boolean isDraft()

Get the draft property: (Preview) Whether this agent version is a draft (candidate) rather than a release. The service defaults to `false` if a value is not specified by the caller. Draft versions are recorded but excluded from default 'latest' resolution and are not auto-promoted.

Returns:

the draft value.

setBlueprintReference

public CreateAgentVersionInput setBlueprintReference(AgentBlueprintReference blueprintReference)

Set the blueprintReference property: The blueprint reference for the agent.

Parameters:

blueprintReference - the blueprintReference value to set.

Returns:

the CreateAgentVersionInput object itself.

setDescription

public CreateAgentVersionInput setDescription(String description)

Set the description property: A human-readable description of the agent.

Parameters:

description - the description value to set.

Returns:

the CreateAgentVersionInput object itself.

setDraft

public CreateAgentVersionInput setDraft(Boolean draft)

Set the draft property: (Preview) Whether this agent version is a draft (candidate) rather than a release. The service defaults to `false` if a value is not specified by the caller. Draft versions are recorded but excluded from default 'latest' resolution and are not auto-promoted.

Parameters:

draft - the draft value to set.

Returns:

the CreateAgentVersionInput object itself.

setMetadata

public CreateAgentVersionInput setMetadata(Map<String,String> metadata)

Set the metadata property: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Parameters:

metadata - the metadata value to set.

Returns:

the CreateAgentVersionInput object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to