Class: Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/embedding_similarity_search_response.rb

Defined Under Namespace

Classes: Metadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(distance:, document_chunk:, metadata:) ⇒ Object

Example document response from embedding service { “document_chunk”: “your status? This is Vanessa Bloome…”, “distance”: 0.18607724, “metadata”: { “source”: “us-central-1.telnyxstorage.com/scripts/bee_movie_script.txt”, “checksum”: “343054dd19bab39bbf6761a3d20f1daa”, “embedding”: “openai/text-embedding-ada-002”, “filename”: “bee_movie_script.txt”, “certainty”: 0.9069613814353943, “loader_metadata”: {} } }

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/telnyx/models/ai/embedding_similarity_search_response.rb', line 17

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute distance
  #
  #   @return [Float]
  required :distance, Float

  # @!attribute document_chunk
  #
  #   @return [String]
  required :document_chunk, String

  # @!attribute metadata
  #
  #   @return [Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data::Metadata]
  required :metadata, -> { Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data::Metadata }

  # @!method initialize(distance:, document_chunk:, metadata:)
  #   Example document response from embedding service { "document_chunk": "your
  #   status? This is Vanessa Bloome...", "distance": 0.18607724, "metadata": {
  #   "source": "https://us-central-1.telnyxstorage.com/scripts/bee_movie_script.txt",
  #   "checksum": "343054dd19bab39bbf6761a3d20f1daa", "embedding":
  #   "openai/text-embedding-ada-002", "filename": "bee_movie_script.txt",
  #   "certainty": 0.9069613814353943, "loader_metadata": {} } }
  #
  #   @param distance [Float]
  #   @param document_chunk [String]
  #   @param metadata [Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data::Metadata]

  # @see Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data#metadata
  class Metadata < Telnyx::Internal::Type::BaseModel
    # @!attribute checksum
    #
    #   @return [String]
    required :checksum, String

    # @!attribute embedding
    #
    #   @return [String]
    required :embedding, String

    # @!attribute filename
    #
    #   @return [String]
    required :filename, String

    # @!attribute source
    #
    #   @return [String]
    required :source, String

    # @!attribute certainty
    #
    #   @return [Float, nil]
    optional :certainty, Float

    # @!attribute loader_metadata
    #
    #   @return [Hash{Symbol=>Object}, nil]
    optional :loader_metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

    # @!method initialize(checksum:, embedding:, filename:, source:, certainty: nil, loader_metadata: nil)
    #   @param checksum [String]
    #   @param embedding [String]
    #   @param filename [String]
    #   @param source [String]
    #   @param certainty [Float]
    #   @param loader_metadata [Hash{Symbol=>Object}]
  end
end

Instance Attribute Details

#distance ⇒ Float

Returns:

  • (Float) 


21
 
# File 'lib/telnyx/models/ai/embedding_similarity_search_response.rb', line 21

required :distance, Float

#document_chunk ⇒ String

Returns:

  • (String) 


26
 
# File 'lib/telnyx/models/ai/embedding_similarity_search_response.rb', line 26

required :document_chunk, String

#metadata ⇒ Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data::Metadata

Returns:



31
 
# File 'lib/telnyx/models/ai/embedding_similarity_search_response.rb', line 31

required :metadata, -> { Telnyx::Models::AI::EmbeddingSimilaritySearchResponse::Data::Metadata }