Class VectorStoreResponse

Namespace

OpenAI.VectorStores

Assembly

OpenAI-DotNet.dll

A vector store is a collection of processed files can be used by the 'file_search' tool.

public sealed class VectorStoreResponse : BaseResponse

Inheritance

object

BaseResponse

VectorStoreResponse

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

CreatedAt

[JsonIgnore]
public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

CreatedAtUnixTimeSeconds

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

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

Property Value

int

ExpirationPolicy

The expiration policy for a vector store.

[JsonInclude]
[JsonPropertyName("expires_after")]
public ExpirationPolicy ExpirationPolicy { get; }

Property Value

ExpirationPolicy

ExpiresAt

[JsonIgnore]
public DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

ExpiresAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the vector store will expire.

[JsonInclude]
[JsonPropertyName("expires_at")]
public int? ExpiresAtUnixTimeSeconds { get; }

Property Value

int?

FileCounts

[JsonInclude]
[JsonPropertyName("file_counts")]
public FileCounts FileCounts { get; }

Property Value

FileCounts

Id

The identifier, which can be referenced in API endpoints.

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

Property Value

string

LastActiveAt

[JsonIgnore]
public DateTimeOffset? LastActiveAt { get; }

Property Value

DateTimeOffset?

LastActiveAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the vector store was last active.

[JsonInclude]
[JsonPropertyName("last_active_at")]
public int? LastActiveAtUnixTimeSeconds { get; }

Property Value

int?

Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

[JsonInclude]
[JsonPropertyName("metadata")]
public Dictionary<string, object> Metadata { get; }

Property Value

Dictionary<string, object>

Name

The name of the vector store.

[JsonInclude]
[JsonPropertyName("name")]
public string Name { get; }

Property Value

string

Object

The object type, which is always 'vector_store'.

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

Property Value

string

Status

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

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

Property Value

VectorStoreStatus

UsageBytes

The total number of bytes used by the files in the vector store.

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

Property Value

long

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(VectorStoreResponse)

public static implicit operator string(VectorStoreResponse response)

Parameters

response VectorStoreResponse

Returns

string