Share via

AzureChatEnhancements Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.AzureChatEnhancements

Implements

JsonSerializable<AzureChatEnhancements>

public final class AzureChatEnhancements
implements JsonSerializable<AzureChatEnhancements>

Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.

Method Summary

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

Reads an instance of AzureChatEnhancements from the JsonReader.
AzureGroundingEnhancement getGrounding()

Get the grounding property: The grounding enhancement that returns the bounding box of the objects detected in the image.
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 AzureChatEnhancements fromJson(JsonReader jsonReader)

Reads an instance of AzureChatEnhancements from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the AzureChatEnhancements.

getGrounding

public AzureGroundingEnhancement getGrounding()

Get the grounding property: The grounding enhancement that returns the bounding box of the objects detected in the image.

Returns:

the grounding value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to