Share via


AgentManifestOptions Class

Definition

The AgentManifestOptions.

public class AgentManifestOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.AgentManifestOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.AgentManifestOptions>
type AgentManifestOptions = class
    interface IJsonModel<AgentManifestOptions>
    interface IPersistableModel<AgentManifestOptions>
Public Class AgentManifestOptions
Implements IJsonModel(Of AgentManifestOptions), IPersistableModel(Of AgentManifestOptions)
Inheritance
AgentManifestOptions
Implements

Properties

Name Description
Description

A human-readable description of the agent.

ManifestId

The manifest ID to import the agent version from.

Metadata

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.

ParameterValues

The inputs to the manifest that will result in a fully materialized Agent.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Implicit(AgentManifestOptions to BinaryContent)

Explicit Interface Implementations

Name Description
IJsonModel<AgentManifestOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AgentManifestOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AgentManifestOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AgentManifestOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AgentManifestOptions>.Write(ModelReaderWriterOptions)

Applies to