Class VectorStoreRequest

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

A helper to create a vector store with file_ids and attach it to an assistant/thread. There can be a maximum of 1 vector store attached to the assistant/thread.

public sealed class VectorStoreRequest

Inheritance

object

VectorStoreRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

VectorStoreRequest()

public VectorStoreRequest()

VectorStoreRequest(IReadOnlyList<string>, IReadOnlyDictionary<string, string>)

Constructor.

public VectorStoreRequest(IReadOnlyList<string> fileIds, IReadOnlyDictionary<string, string> metadata = null)

Parameters

fileIds IReadOnlyList<string>

A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.

metadata IReadOnlyDictionary<string, string>

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

VectorStoreRequest(string, IReadOnlyDictionary<string, string>)

public VectorStoreRequest(string fileId, IReadOnlyDictionary<string, string> metadata = null)

Parameters

fileId string

metadata IReadOnlyDictionary<string, string>

Properties

FileIds

A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.

[JsonInclude]
[JsonPropertyName("file_ids")]
public IReadOnlyList<string> FileIds { get; }

Property Value

IReadOnlyList<string>

Metadata

Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store 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 IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

Operators

implicit operator VectorStoreRequest(List<string>)

public static implicit operator VectorStoreRequest(List<string> fileIds)

Parameters

fileIds List<string>

Returns

VectorStoreRequest

implicit operator VectorStoreRequest(string)

public static implicit operator VectorStoreRequest(string fileId)

Parameters

fileId string

Returns

VectorStoreRequest