Share via


BingCustomSearchToolCallOutput Class

Definition

The output of a Bing custom search tool call.

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

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from AgentResponseItem)
CallId

The unique ID of the tool call generated by the model.

Id

Gets the Id.

(Inherited from AgentResponseItem)
Output

The output from the Bing custom search 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).

<remarks> Supported types:

</remarks>

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" }.

ResponseId

The response on which the item is created.

(Inherited from AgentResponseItem)
Status

The status of the tool call.

Methods

Name Description
AsResponseResultItem() (Inherited from AgentResponseItem)
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to