Search Results for

    Show / Hide Table of Contents

    Class AI21FileInfoVerbose

    Inheritance
    object
    AI21FileInfoVerbose
    Implements
    IUploadedFile
    IAIResource
    IData
    IHasId<string>
    IHasName
    IDeprecatable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit.AI21Labs
    Assembly: Glitch9.AIDevKit.Provider.AI21.dll
    Syntax
    public sealed class AI21FileInfoVerbose : IUploadedFile, IAIResource, IData, IHasId<string>, IHasName, IDeprecatable

    Properties

    | Edit this page View Source

    Api

    Declaration
    [JsonIgnore]
    public Api Api { get; }
    Property Value
    Type Description
    Api
    | Edit this page View Source

    ByteSize

    Required. The size of the file in bytes.

    Declaration
    [JsonProperty("sizeBytes")]
    public int ByteSize { get; set; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    CreatedAt

    Required. The date when the file was uploaded.

    Declaration
    [JsonProperty("creationDate")]
    public UnixTime? CreatedAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    CreatedBy

    Required. The identifier of the user who uploaded the file.

    Declaration
    [JsonProperty("createdBy")]
    public string CreatedBy { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    DataSource

    Required. Where was the file uploaded from.

    Declaration
    [JsonProperty("dataSource")]
    public string DataSource { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    ExpiresAt

    Gets the file expiration timestamp, if the provider defines one. Returns null when the file has no expiration policy.

    Declaration
    [JsonIgnore]
    public UnixTime? ExpiresAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    FileType

    Required. The type of the file.

    Declaration
    [JsonProperty("fileType")]
    public string FileType { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Id

    Required. The unique identifier of the file, generated by AI21.

    Declaration
    [JsonProperty("fileId")]
    public string Id { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Labels

    Optional. The labels associated with the file. You can apply arbitrary string labels to your files and limit queries to files with one or more labels. Similar to paths, but labels do not prefix match. Labels are case-sensitive.

    Declaration
    [JsonProperty("labels")]
    public string[] Labels { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    LastUpdatedAt

    Required. The last update date of the file in the library.

    Declaration
    [JsonProperty("lastUpdated")]
    public UnixTime? LastUpdatedAt { get; set; }
    Property Value
    Type Description
    UnixTime?
    | Edit this page View Source

    MimeType

    Gets the MIME type associated with the file. This can be used to select preview, parsing, or processing paths.

    Declaration
    [JsonIgnore]
    public MimeType MimeType { get; set; }
    Property Value
    Type Description
    MimeType
    | Edit this page View Source

    Name

    Required. The name of the file specified by you.

    Declaration
    [JsonProperty("name")]
    public string Name { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Path

    Required. An arbitrary file-path-like string you can assign to indicate the content of a file.

    Declaration
    [JsonProperty("path")]
    public string Path { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    PublicUrl

    Optional. The public URL of the file, specified by you. This URL is not validated by AI21 or used in any way. It is strictly a piece of metadata that you can optionally attach to a file.

    Declaration
    [JsonProperty("publicUrl")]
    public string PublicUrl { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Status

    Required. The status of the file in the library.

    Declaration
    [JsonProperty("status")]
    public AI21FileStatus Status { get; set; }
    Property Value
    Type Description
    AI21FileStatus

    Methods

    | Edit this page View Source

    GetMetadata()

    Declaration
    public SerializableMetadata GetMetadata()
    Returns
    Type Description
    SerializableMetadata

    Implements

    IUploadedFile
    IAIResource
    IData
    IHasId<TId>
    IHasName
    IDeprecatable

    Extension Methods

    ArrayExtensions.ToArrayOrEmpty<T>(T)
    ArrayExtensions.ToArrayOrNull<T>(T)
    EventExtensions.ToDelta<T>(T, string, int, string, bool)
    EventExtensions.ToDone<T>(T, string, int, string)
    EventExtensions.ToEvent<T>(T)
    EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)
    FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)
    ResponseCastingExtensions.GetResult<T>(T)
    CoreLibTypeExtensions.GetNameOrDash(IData)
    CoreLibTypeExtensions.GetIdOrNull(IHasId<string>)
    CoreLibTypeExtensions.IsNullOrEmptyId(IHasId<string>)
    SystemExtensions.GetName(object)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation