Share via

FileInfo interface

Package:
@azure/ai-agents

Represents an agent that can call the model and use tools.

Properties

bytes

The size of the file, in bytes.
createdAt

The Unix timestamp, in seconds, representing when this object was created.
filename

The name of the file.
id

The identifier, which can be referenced in API endpoints.
object

The object type, which is always 'file'.
purpose

The intended purpose of a file.
status

The state of the file. This field is available in Azure OpenAI only.
statusDetails

The error message with details in case processing of this file failed. This field is available in Azure OpenAI only.

Property Details

bytes

The size of the file, in bytes.

bytes: number

Property Value

number

createdAt

The Unix timestamp, in seconds, representing when this object was created.

createdAt: Date

Property Value

Date

filename

The name of the file.

filename: string

Property Value

string

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

object

The object type, which is always 'file'.

object: "file"

Property Value

"file"

purpose

The intended purpose of a file.

purpose: FilePurpose

Property Value

FilePurpose

status

The state of the file. This field is available in Azure OpenAI only.

status?: FileState

Property Value

FileState

statusDetails

The error message with details in case processing of this file failed. This field is available in Azure OpenAI only.

statusDetails?: string

Property Value

string