Class VectorStoreFileResponse

Namespace

OpenAI.VectorStores

Assembly

OpenAI-DotNet.dll

A list of files attached to a vector store.

public sealed class VectorStoreFileResponse : BaseResponse

Inheritance

object

BaseResponse

VectorStoreFileResponse

Inherited Members

BaseResponse.Client

BaseResponse.ProcessingTime

BaseResponse.Organization

BaseResponse.RequestId

BaseResponse.OpenAIVersion

BaseResponse.LimitRequests

BaseResponse.LimitTokens

BaseResponse.RemainingRequests

BaseResponse.RemainingTokens

BaseResponse.ResetRequests

BaseResponse.ResetRequestsTimespan

BaseResponse.ResetTokens

BaseResponse.ResetTokensTimespan

BaseResponse.ToJsonString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

ChunkingStrategy

The strategy used to chunk the file.

[JsonInclude]
[JsonPropertyName("chunking_strategy")]
public ChunkingStrategy ChunkingStrategy { get; }

Property Value

ChunkingStrategy

CreatedAt

[JsonIgnore]
public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

CreatedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the vector store file was created.

[JsonInclude]
[JsonPropertyName("created_at")]
public int CreatedAtUnixTimeSeconds { get; }

Property Value

int

Id

The identifier, which can be referenced in API endpoints.

[JsonInclude]
[JsonPropertyName("id")]
public string Id { get; }

Property Value

string

LastError

The last error associated with this vector store file. Will be 'null' if there are no errors.

[JsonInclude]
[JsonPropertyName("last_error")]
public Error LastError { get; }

Property Value

Error

Object

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

[JsonInclude]
[JsonPropertyName("object")]
public string Object { get; }

Property Value

string

Status

The status of the vector store file, which can be either 'in_progress', 'completed', 'cancelled', or 'failed'. The status 'completed' indicates that the vector store file is ready for use.

[JsonInclude]
[JsonPropertyName("status")]
public VectorStoreFileStatus Status { get; }

Property Value

VectorStoreFileStatus

UsageBytes

The total vector store usage in bytes. Note that this may be different from the original file size.

[JsonInclude]
[JsonPropertyName("usage_bytes")]
public long UsageBytes { get; }

Property Value

long

VectorStoreId

The ID of the vector store that the file is attached to.

[JsonInclude]
[JsonPropertyName("vector_store_id")]
public string VectorStoreId { get; }

Property Value

string

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator string(VectorStoreFileResponse)

public static implicit operator string(VectorStoreFileResponse response)

Parameters

response VectorStoreFileResponse

Returns

string