Table of Contents

Class Status

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

public class Status
Inheritance
Status
Inherited Members
Extension Methods

Properties

Code

The status code, which should be an enum value of google.rpc.Code.

[JsonPropertyName("code")]
public int Code { get; set; }

Property Value

int

Details

A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field @type contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

[JsonPropertyName("details")]
public List<Dictionary<string, JsonElement>>? Details { get; set; }

Property Value

List<Dictionary<string, JsonElement>>

Message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the Details field, or localized by the client.

[JsonPropertyName("message")]
public string? Message { get; set; }

Property Value

string

See Also