XaiFileResult

Namespace: Vercel.AI.Xai

public sealed class XaiFileResult

Result of an xAI file upload or metadata read.

Inheritance: object

View source

Constructors

XaiFileResult(IReadOnlyDictionary<string, string>, XaiFileMetadata, string?, string?, long?, DateTimeOffset?, DateTimeOffset?)

public XaiFileResult(IReadOnlyDictionary<string, string> providerReference, XaiFileMetadata metadata, string? fileName, string? mediaType, long? byteSize, DateTimeOffset? createdAt, DateTimeOffset? expiresAt)

Creates a file result.

Parameters

Name	Type	Description
providerReference	IReadOnlyDictionary<string, string>
metadata	XaiFileMetadata
fileName	string
mediaType	string
byteSize	long?
createdAt	DateTimeOffset?
expiresAt	DateTimeOffset?

View source

Properties

ByteSize

public long? ByteSize { get; }

Size in bytes, when the response includes it.

Value: long?

View source

CreatedAt

public DateTimeOffset? CreatedAt { get; }

Creation time.

Value: DateTimeOffset?

View source

ExpiresAt

public DateTimeOffset? ExpiresAt { get; }

Expiration time.

Value: DateTimeOffset?

View source

FileName

public string? FileName { get; }

File name from the response, or the name that was uploaded.

Value: string

View source

MediaType

public string? MediaType { get; }

Media type supplied by the caller.

Value: string

View source

Metadata

public XaiFileMetadata Metadata { get; }

Response fields. Fields the response did not return are null.

Value: XaiFileMetadata

View source

ProviderReference

public IReadOnlyDictionary<string, string> ProviderReference { get; }

Reference containing the xai file id.

Value: IReadOnlyDictionary<string, string>

View source

Warnings

public IReadOnlyList<ModelWarning> Warnings { get; }

Always empty.

Value: IReadOnlyList<ModelWarning>

View source