twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/assistants/v1/knowledge.rb

@@ -26,7 +26,8 @@ module Twilio
                             # @param [name]: [String] The name of the tool.
                             # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
                             # @param [type]: [String] The type of the knowledge source.
-                        attr_accessor :assistant_id, :description, :knowledge_source_details, :name, :policy, :type
+                            # @param [embedding_model]: [String] The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types.
+                        attr_accessor :assistant_id, :description, :knowledge_source_details, :name, :policy, :type, :embedding_model
                         def initialize(payload)
                                 @assistant_id = payload["assistant_id"]
                                 @description = payload["description"]
@@ -34,15 +35,17 @@ module Twilio
                                 @name = payload["name"]
                                 @policy = payload["policy"]
                                 @type = payload["type"]
+                                @embedding_model = payload["embedding_model"]
                         end
                         def to_json(options = {})
                         {
-                                assistant_id: @assistant_id,
-                                description: @description,
-                                knowledge_source_details: @knowledge_source_details,
-                                name: @name,
-                                policy: @policy,
-                                type: @type,
+                                "assistant_id": @assistant_id,
+                                "description": @description,
+                                "knowledge_source_details": @knowledge_source_details,
+                                "name": @name,
+                                "policy": @policy,
+                                "type": @type,
+                                "embedding_model": @embedding_model,
                         }.to_json(options)
                         end
                     end
@@ -63,11 +66,11 @@ module Twilio
                         end
                         def to_json(options = {})
                         {
-                                description: @description,
-                                id: @id,
-                                name: @name,
-                                policy_details: @policy_details,
-                                type: @type,
+                                "description": @description,
+                                "id": @id,
+                                "name": @name,
+                                "policy_details": @policy_details,
+                                "type": @type,
                         }.to_json(options)
                         end
                     end
@@ -78,25 +81,29 @@ module Twilio
                             # @param [name]: [String] The name of the knowledge source.
                             # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
                             # @param [type]: [String] The description of the knowledge source.
-                        attr_accessor :description, :knowledge_source_details, :name, :policy, :type
+                            # @param [embedding_model]: [String] The embedding model to be used for the knowledge source. It's only applicable to 'Database' type.
+                        attr_accessor :description, :knowledge_source_details, :name, :policy, :type, :embedding_model
                         def initialize(payload)
                                 @description = payload["description"]
                                 @knowledge_source_details = payload["knowledge_source_details"]
                                 @name = payload["name"]
                                 @policy = payload["policy"]
                                 @type = payload["type"]
+                                @embedding_model = payload["embedding_model"]
                         end
                         def to_json(options = {})
                         {
-                                description: @description,
-                                knowledge_source_details: @knowledge_source_details,
-                                name: @name,
-                                policy: @policy,
-                                type: @type,
+                                "description": @description,
+                                "knowledge_source_details": @knowledge_source_details,
+                                "name": @name,
+                                "policy": @policy,
+                                "type": @type,
+                                "embedding_model": @embedding_model,
                         }.to_json(options)
                         end
                     end
 
+
                     class AssistantsV1ServiceCreateKnowledgeRequest
                             # @param [assistant_id]: [String] The Assistant ID.
                             # @param [description]: [String] The description of the knowledge source.
@@ -104,7 +111,8 @@ module Twilio
                             # @param [name]: [String] The name of the tool.
                             # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
                             # @param [type]: [String] The type of the knowledge source.
-                        attr_accessor :assistant_id, :description, :knowledge_source_details, :name, :policy, :type
+                            # @param [embedding_model]: [String] The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types.
+                        attr_accessor :assistant_id, :description, :knowledge_source_details, :name, :policy, :type, :embedding_model
                         def initialize(payload)
                                 @assistant_id = payload["assistant_id"]
                                 @description = payload["description"]
@@ -112,15 +120,17 @@ module Twilio
                                 @name = payload["name"]
                                 @policy = payload["policy"]
                                 @type = payload["type"]
+                                @embedding_model = payload["embedding_model"]
                         end
                         def to_json(options = {})
                         {
-                                assistant_id: @assistant_id,
-                                description: @description,
-                                knowledge_source_details: @knowledge_source_details,
-                                name: @name,
-                                policy: @policy,
-                                type: @type,
+                                "assistant_id": @assistant_id,
+                                "description": @description,
+                                "knowledge_source_details": @knowledge_source_details,
+                                "name": @name,
+                                "policy": @policy,
+                                "type": @type,
+                                "embedding_model": @embedding_model,
                         }.to_json(options)
                         end
                     end
@@ -141,11 +151,11 @@ module Twilio
                         end
                         def to_json(options = {})
                         {
-                                description: @description,
-                                id: @id,
-                                name: @name,
-                                policy_details: @policy_details,
-                                type: @type,
+                                "description": @description,
+                                "id": @id,
+                                "name": @name,
+                                "policy_details": @policy_details,
+                                "type": @type,
                         }.to_json(options)
                         end
                     end
@@ -156,31 +166,36 @@ module Twilio
                             # @param [name]: [String] The name of the knowledge source.
                             # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
                             # @param [type]: [String] The description of the knowledge source.
-                        attr_accessor :description, :knowledge_source_details, :name, :policy, :type
+                            # @param [embedding_model]: [String] The embedding model to be used for the knowledge source. It's only applicable to 'Database' type.
+                        attr_accessor :description, :knowledge_source_details, :name, :policy, :type, :embedding_model
                         def initialize(payload)
                                 @description = payload["description"]
                                 @knowledge_source_details = payload["knowledge_source_details"]
                                 @name = payload["name"]
                                 @policy = payload["policy"]
                                 @type = payload["type"]
+                                @embedding_model = payload["embedding_model"]
                         end
                         def to_json(options = {})
                         {
-                                description: @description,
-                                knowledge_source_details: @knowledge_source_details,
-                                name: @name,
-                                policy: @policy,
-                                type: @type,
+                                "description": @description,
+                                "knowledge_source_details": @knowledge_source_details,
+                                "name": @name,
+                                "policy": @policy,
+                                "type": @type,
+                                "embedding_model": @embedding_model,
                         }.to_json(options)
                         end
                     end
 
+
                     ##
                     # Initialize the KnowledgeList
                     # @param [Version] version Version that contains the resource
                     # @return [KnowledgeList] KnowledgeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Knowledge"
@@ -195,6 +210,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, headers: headers, data: assistants_v1_service_create_knowledge_request.to_json)
                         KnowledgeInstance.new(
                             @version,
@@ -202,6 +221,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the KnowledgeInstanceMetadata
+                    # @param [AssistantsV1ServiceCreateKnowledgeRequest] assistants_v1_service_create_knowledge_request 
+                    # @return [KnowledgeInstance] Created KnowledgeInstance
+                    def create_with_metadata(assistants_v1_service_create_knowledge_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: assistants_v1_service_create_knowledge_request.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists KnowledgeInstance records from the API as a list.
@@ -245,6 +290,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists KnowledgePageMetadata records from the API as a list.
+                      # @param [String] assistant_id 
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(assistant_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'AssistantId' => assistant_id,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        KnowledgePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields KnowledgeInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -267,15 +336,18 @@ module Twilio
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
                     # @return [Page] Page of KnowledgeInstance
-                    def page(assistant_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(assistant_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'AssistantId' => assistant_id,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         KnowledgePage.new(@version, response, @solution)
                     end
@@ -310,6 +382,7 @@ module Twilio
                     # @return [KnowledgeContext] KnowledgeContext
                     def initialize(version, id)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { id: id,  }
@@ -326,9 +399,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the KnowledgeInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          knowledge_instance = KnowledgeInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          KnowledgeInstanceMetadata.new(@version, knowledge_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the KnowledgeInstance
                     # @return [KnowledgeInstance] Fetched KnowledgeInstance
@@ -336,6 +431,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         KnowledgeInstance.new(
                             @version,
@@ -344,6 +443,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the KnowledgeInstanceMetadata
+                    # @return [KnowledgeInstance] Fetched KnowledgeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the KnowledgeInstance
                     # @param [AssistantsV1ServiceUpdateKnowledgeRequest] assistants_v1_service_update_knowledge_request 
@@ -353,6 +477,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
                         payload = @version.update('PUT', @uri, headers: headers, data: assistants_v1_service_update_knowledge_request.to_json)
                         KnowledgeInstance.new(
                             @version,
@@ -361,6 +489,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the KnowledgeInstanceMetadata
+                    # @param [AssistantsV1ServiceUpdateKnowledgeRequest] assistants_v1_service_update_knowledge_request 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update_with_metadata(assistants_v1_service_update_knowledge_request: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('PUT', @uri, headers: headers, data: assistants_v1_service_update_knowledge_request.to_json)
+                        knowledge_instance = KnowledgeInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        KnowledgeInstanceMetadata.new(
+                            @version,
+                            knowledge_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the chunks
                     # @return [ChunkList]
@@ -398,6 +553,53 @@ module Twilio
                     end
                 end
 
+                class KnowledgeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new KnowledgeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}KnowledgeInstance] knowledge_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [KnowledgeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, knowledge_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @knowledge_instance = knowledge_instance
+                    end
+
+                    def knowledge
+                        @knowledge_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.KnowledgeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class KnowledgeListResponse < InstanceListResource
+                    # @param [Array<KnowledgeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @knowledge_instance = payload.body[key].map do |data|
+                        KnowledgeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def knowledge_instance
+                          @instance
+                      end
+                  end
+
                 class KnowledgePage < Page
                     ##
                     # Initialize the KnowledgePage
@@ -407,6 +609,7 @@ module Twilio
                     # @return [KnowledgePage] KnowledgePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -426,6 +629,66 @@ module Twilio
                         '<Twilio.Assistants.V1.KnowledgePage>'
                     end
                 end
+
+                class KnowledgePageMetadata < PageMetadata
+                    attr_reader :knowledge_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @knowledge_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @knowledge_page << KnowledgeListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @knowledge_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Assistants::V1PageMetadata>';
+                    end
+                end
+                class KnowledgeListResponse < InstanceListResource
+
+                    # @param [Array<KnowledgeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @knowledge = data_list.map do |data|
+                        KnowledgeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def knowledge
+                        @knowledge
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class KnowledgeInstance < InstanceResource
                     ##
                     # Initialize the KnowledgeInstance
@@ -439,6 +702,7 @@ module Twilio
                     def initialize(version, payload , id: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'description' => payload['description'],
@@ -449,6 +713,7 @@ module Twilio
                             'status' => payload['status'],
                             'type' => payload['type'],
                             'url' => payload['url'],
+                            'embedding_model' => payload['embedding_model'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                         }
@@ -517,6 +782,12 @@ module Twilio
                         @properties['url']
                     end
                     
+                    ##
+                    # @return [String] The embedding model to be used for the knowledge source.
+                    def embedding_model
+                        @properties['embedding_model']
+                    end
+                    
                     ##
                     # @return [Time] The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_created