Class ResponseJsonSchema

The JSON schema definition to be used in JSON_SCHEMA response format.

Inheritance

object

ResponseJsonSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaiinferenceService.Models

Assembly: OCI.DotNetSDK.Generativeaiinference.dll

Syntax

public class ResponseJsonSchema

Properties

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A description of what the response format is for, used by the model to determine how to respond in the format.

IsStrict

Declaration

[JsonProperty(PropertyName = "isStrict")]
public bool? IsStrict { get; set; }

Property Value

Type	Description
bool?	Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes.

Remarks

Required

Schema

Declaration

[JsonProperty(PropertyName = "schema")]
public object Schema { get; set; }

Property Value

Type	Description
object	The schema used by the structured output, described as a JSON Schema object.