Share via


SessionResponseMcpCallItem Class

Definition

A response item that represents a call to an MCP tool.

public class SessionResponseMcpCallItem : Azure.AI.VoiceLive.SessionResponseItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.VoiceLive.SessionResponseMcpCallItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.VoiceLive.SessionResponseMcpCallItem>
type SessionResponseMcpCallItem = class
    inherit SessionResponseItem
    interface IJsonModel<SessionResponseMcpCallItem>
    interface IPersistableModel<SessionResponseMcpCallItem>
Public Class SessionResponseMcpCallItem
Inherits SessionResponseItem
Implements IJsonModel(Of SessionResponseMcpCallItem), IPersistableModel(Of SessionResponseMcpCallItem)
Inheritance
SessionResponseMcpCallItem
Implements

Properties

Name Description
ApprovalRequestId

The ID of the approval request, if any.

Arguments

The arguments for the tool call.

Error

The error, if any, from the tool call.

To assign an object to 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" }.

Id

Gets the Id.

(Inherited from SessionResponseItem)
Name

The name of the tool to call.

Output

The output of the tool call.

ServerLabel

The label of the server that provides the tool.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<SessionResponseItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from SessionResponseItem)
IJsonModel<SessionResponseItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from SessionResponseItem)
IJsonModel<SessionResponseMcpCallItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<SessionResponseMcpCallItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<SessionResponseItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from SessionResponseItem)
IPersistableModel<SessionResponseItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from SessionResponseItem)
IPersistableModel<SessionResponseItem>.Write(ModelReaderWriterOptions) (Inherited from SessionResponseItem)
IPersistableModel<SessionResponseMcpCallItem>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<SessionResponseMcpCallItem>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<SessionResponseMcpCallItem>.Write(ModelReaderWriterOptions)

Applies to