telnyx 5.161.0 → 5.163.0

data/lib/telnyx/models/ai/collection_retrieve_documents_response.rb

@@ -5,175 +5,104 @@ module Telnyx
     module AI
       # @see Telnyx::Resources::AI::Collections#retrieve_documents
       class CollectionRetrieveDocumentsResponse < Telnyx::Internal::Type::BaseModel
-        # @!attribute data
+        # @!attribute id
         #
-        #   @return [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>, nil]
-        optional :data,
-                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data] }
+        #   @return [String, nil]
+        optional :id, String
 
-        # @!attribute meta
+        # @!attribute chunk_index
         #
-        #   @return [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta, nil]
-        optional :meta, -> { Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta }
+        #   @return [Integer, nil]
+        optional :chunk_index, Integer
 
-        # @!method initialize(data: nil, meta: nil)
-        #   @param data [Array<Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data>]
-        #   @param meta [Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Meta]
-
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute chunk_index
-          #
-          #   @return [Integer, nil]
-          optional :chunk_index, Integer
-
-          # @!attribute chunk_total
-          #
-          #   @return [Integer, nil]
-          optional :chunk_total, Integer
-
-          # @!attribute ingested_at
-          #
-          #   @return [Time, nil]
-          optional :ingested_at, Time
-
-          # @!attribute metadata
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-          # @!attribute organization_id
-          #
-          #   @return [String, nil]
-          optional :organization_id, String
-
-          # @!attribute record_created_at
-          #
-          #   @return [Time, nil]
-          optional :record_created_at, Time
-
-          # @!attribute record_id
-          #
-          #   @return [String, nil]
-          optional :record_id, String
-
-          # @!attribute record_type
-          #   The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
-          #   `message`).
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-
-          # @!attribute region
-          #
-          #   @return [String, nil]
-          optional :region, String
-
-          # @!attribute score
-          #   Relevance score (higher = more relevant) for ranked search. `0.0` for plain
-          #   catalog listings (when `query` is omitted).
-          #
-          #   @return [Float, nil]
-          optional :score, Float
-
-          # @!attribute text
-          #
-          #   @return [String, nil]
-          optional :text, String
+        # @!attribute chunk_total
+        #
+        #   @return [Integer, nil]
+        optional :chunk_total, Integer
 
-          # @!attribute user_id
-          #
-          #   @return [String, nil]
-          optional :user_id, String
+        # @!attribute ingested_at
+        #
+        #   @return [Time, nil]
+        optional :ingested_at, Time
 
-          # @!method initialize(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::CollectionRetrieveDocumentsResponse::Data} for more
-          #   details.
-          #
-          #   @param id [String]
-          #
-          #   @param chunk_index [Integer]
-          #
-          #   @param chunk_total [Integer]
-          #
-          #   @param ingested_at [Time]
-          #
-          #   @param metadata [Hash{Symbol=>Object}]
-          #
-          #   @param organization_id [String]
-          #
-          #   @param record_created_at [Time]
-          #
-          #   @param record_id [String]
-          #
-          #   @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
-          #
-          #   @param region [String]
-          #
-          #   @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
-          #
-          #   @param text [String]
-          #
-          #   @param user_id [String]
-        end
+        # @!attribute metadata
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
-        # @see Telnyx::Models::AI::CollectionRetrieveDocumentsResponse#meta
-        class Meta < Telnyx::Internal::Type::BaseModel
-          # @!attribute collection_slug
-          #
-          #   @return [String, nil]
-          optional :collection_slug, String
+        # @!attribute organization_id
+        #
+        #   @return [String, nil]
+        optional :organization_id, String
 
-          # @!attribute page_number
-          #
-          #   @return [Integer, nil]
-          optional :page_number, Integer
+        # @!attribute record_created_at
+        #
+        #   @return [Time, nil]
+        optional :record_created_at, Time
 
-          # @!attribute page_size
-          #
-          #   @return [Integer, nil]
-          optional :page_size, Integer
+        # @!attribute record_id
+        #
+        #   @return [String, nil]
+        optional :record_id, String
 
-          # @!attribute retrieval_type
-          #
-          #   @return [String, nil]
-          optional :retrieval_type, String
+        # @!attribute record_type
+        #   The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
+        #   `message`).
+        #
+        #   @return [String, nil]
+        optional :record_type, String
 
-          # @!attribute searched_sources
-          #
-          #   @return [Array<String>, nil]
-          optional :searched_sources, Telnyx::Internal::Type::ArrayOf[String]
+        # @!attribute region
+        #
+        #   @return [String, nil]
+        optional :region, String
 
-          # @!attribute top_k
-          #
-          #   @return [Integer, nil]
-          optional :top_k, Integer
+        # @!attribute score
+        #   Relevance score (higher = more relevant) for ranked search. `0.0` for plain
+        #   catalog listings (when `query` is omitted).
+        #
+        #   @return [Float, nil]
+        optional :score, Float
 
-          # @!attribute total_pages
-          #
-          #   @return [Integer, nil]
-          optional :total_pages, Integer
+        # @!attribute text
+        #
+        #   @return [String, nil]
+        optional :text, String
 
-          # @!attribute total_results
-          #
-          #   @return [Integer, nil]
-          optional :total_results, Integer
+        # @!attribute user_id
+        #
+        #   @return [String, nil]
+        optional :user_id, String
 
-          # @!method initialize(collection_slug: nil, page_number: nil, page_size: nil, retrieval_type: nil, searched_sources: nil, top_k: nil, total_pages: nil, total_results: nil)
-          #   @param collection_slug [String]
-          #   @param page_number [Integer]
-          #   @param page_size [Integer]
-          #   @param retrieval_type [String]
-          #   @param searched_sources [Array<String>]
-          #   @param top_k [Integer]
-          #   @param total_pages [Integer]
-          #   @param total_results [Integer]
-        end
+        # @!method initialize(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::CollectionRetrieveDocumentsResponse} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param chunk_index [Integer]
+        #
+        #   @param chunk_total [Integer]
+        #
+        #   @param ingested_at [Time]
+        #
+        #   @param metadata [Hash{Symbol=>Object}]
+        #
+        #   @param organization_id [String]
+        #
+        #   @param record_created_at [Time]
+        #
+        #   @param record_id [String]
+        #
+        #   @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
+        #
+        #   @param region [String]
+        #
+        #   @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
+        #
+        #   @param text [String]
+        #
+        #   @param user_id [String]
       end
     end
   end

data/lib/telnyx/models/ai/conversation_add_message_params.rb

@@ -56,7 +56,12 @@ module Telnyx
         #   @return [String, Hash{Symbol=>Object}, nil]
         optional :tool_choice, union: -> { Telnyx::AI::ConversationAddMessageParams::ToolChoice }
 
-        # @!method initialize(conversation_id:, role:, content: nil, metadata: nil, name: nil, sent_at: nil, tool_call_id: nil, tool_calls: nil, tool_choice: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(conversation_id:, role:, content: nil, metadata: nil, name: nil, sent_at: nil, tool_call_id: nil, tool_calls: nil, tool_choice: nil, idempotency_key: nil, request_options: {})
         #   @param conversation_id [String] The ID of the conversation
         #
         #   @param role [String]
@@ -75,6 +80,8 @@ module Telnyx
         #
         #   @param tool_choice [String, Hash{Symbol=>Object}]
         #
+        #   @param idempotency_key [String]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         module Metadata

data/lib/telnyx/models/ai/conversation_create_params.rb

@@ -20,7 +20,12 @@ module Telnyx
         #   @return [String, nil]
         optional :name, String
 
-        # @!method initialize(metadata: nil, name: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(metadata: nil, name: nil, idempotency_key: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::ConversationCreateParams} for more details.
         #
@@ -28,6 +33,8 @@ module Telnyx
         #
         #   @param name [String]
         #
+        #   @param idempotency_key [String]
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/telnyx/models/ai/conversation_flow.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class ConversationFlow < Telnyx::Internal::Type::BaseModel
+        # @!attribute nodes
+        #   All nodes in the flow.
+        #
+        #   @return [Array<Telnyx::Models::AI::FlowNode, Telnyx::Models::AI::ToolNode, Telnyx::Models::AI::SpeakNode>]
+        required :nodes, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::ConversationFlow::Node] }
+
+        # @!attribute start_node_id
+        #   ID of the node where the conversation begins.
+        #
+        #   @return [String]
+        required :start_node_id, String
+
+        # @!attribute edges
+        #   Directed transitions between nodes.
+        #
+        #   @return [Array<Telnyx::Models::AI::FlowEdge>, nil]
+        optional :edges, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::FlowEdge] }
+
+        # @!method initialize(nodes:, start_node_id:, edges: nil)
+        #   Conversation flow as returned by the API.
+        #
+        #   @param nodes [Array<Telnyx::Models::AI::FlowNode, Telnyx::Models::AI::ToolNode, Telnyx::Models::AI::SpeakNode>] All nodes in the flow.
+        #
+        #   @param start_node_id [String] ID of the node where the conversation begins.
+        #
+        #   @param edges [Array<Telnyx::Models::AI::FlowEdge>] Directed transitions between nodes.
+
+        # One step in a conversation flow, as returned by the API.
+        module Node
+          extend Telnyx::Internal::Type::Union
+
+          discriminator :type
+
+          # One step in a conversation flow, as returned by the API.
+          variant :prompt, -> { Telnyx::AI::FlowNode }
+
+          # A standalone tool step in a conversation flow, as returned by the API.
+          variant :tool, -> { Telnyx::AI::ToolNode }
+
+          # A standalone scripted-message step in a flow, as returned by the API.
+          variant :speak, -> { Telnyx::AI::SpeakNode }
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::AI::FlowNode, Telnyx::Models::AI::ToolNode, Telnyx::Models::AI::SpeakNode)]
+        end
+      end
+    end
+  end
+end