Class FileSearchResult

Namespace

OpenAI.Responses

Assembly

OpenAI-DotNet.dll

public sealed class FileSearchResult

Inheritance

object

FileSearchResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Attributes

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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("attributes")]
public IReadOnlyDictionary<string, object> Attributes { get; }

Property Value

IReadOnlyDictionary<string, object>

FileId

The unique ID of the file.

[JsonInclude]
[JsonPropertyName("file_id")]
public string FileId { get; }

Property Value

string

FileName

The name of the file.

[JsonInclude]
[JsonPropertyName("file_name")]
public string FileName { get; }

Property Value

string

Score

The relevance score of the file - a value between 0 and 1.

[JsonInclude]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("score")]
public float? Score { get; }

Property Value

float?

Text

The text that was retrieved from the file.

[JsonInclude]
[JsonPropertyName("text")]
public string Text { get; }

Property Value

string