View Source ExOpenAI.Components.VectorStoreSearchResultItem (ex_openai.ex v2.0.0-beta2)

Module for representing the OpenAI schema VectorStoreSearchResultItem.

Fields

  • :attributes - required - ExOpenAI.Components.VectorStoreFileAttributes.t()

  • :content - required - [ExOpenAI.Components.VectorStoreSearchResultContentObject.t()]
    Content chunks from the file.

  • :file_id - required - String.t()
    The ID of the vector store file.

  • :filename - required - String.t()
    The name of the vector store file.

  • :score - required - number()
    The similarity score for the result.
    Constraints: minimum: 0, maximum: 1

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.VectorStoreSearchResultItem{
  attributes: ExOpenAI.Components.VectorStoreFileAttributes.t(),
  content: [ExOpenAI.Components.VectorStoreSearchResultContentObject.t()],
  file_id: String.t(),
  filename: String.t(),
  score: number()
}