twilio-ruby 5.74.4 → 7.7.1

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

@@ -0,0 +1,629 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Assistants
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Assistants < AssistantsBase
+            class V1 < Version
+                class KnowledgeList < ListResource
+                
+                    class AssistantsV1ServiceCreateKnowledgeRequest
+                            # @param [assistant_id]: [String] The Assistant ID.
+                            # @param [description]: [String] The description of the knowledge source.
+                            # @param [knowledge_source_details]: [Hash] The details of the knowledge source based on the type.
+                            # @param [name]: [String] The name of the tool.
+                            # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
+                            # @param [type]: [String] The type of the knowledge source.
+                            # @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"]
+                                @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 = {})
+                        {
+                                "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
+
+                    class AssistantsV1ServiceCreatePolicyRequest
+                            # @param [description]: [String] The description of the policy.
+                            # @param [id]: [String] The Policy ID.
+                            # @param [name]: [String] The name of the policy.
+                            # @param [policy_details]: [Hash] 
+                            # @param [type]: [String] The description of the policy.
+                        attr_accessor :description, :id, :name, :policy_details, :type
+                        def initialize(payload)
+                                @description = payload["description"]
+                                @id = payload["id"]
+                                @name = payload["name"]
+                                @policy_details = payload["policy_details"]
+                                @type = payload["type"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "description": @description,
+                                "id": @id,
+                                "name": @name,
+                                "policy_details": @policy_details,
+                                "type": @type,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class AssistantsV1ServiceUpdateKnowledgeRequest
+                            # @param [description]: [String] The description of the knowledge source.
+                            # @param [knowledge_source_details]: [Hash] The details of the knowledge source based on the type.
+                            # @param [name]: [String] The name of the knowledge source.
+                            # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
+                            # @param [type]: [String] The description of the knowledge source.
+                            # @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,
+                                "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.
+                            # @param [knowledge_source_details]: [Hash] The details of the knowledge source based on the type.
+                            # @param [name]: [String] The name of the tool.
+                            # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
+                            # @param [type]: [String] The type of the knowledge source.
+                            # @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"]
+                                @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 = {})
+                        {
+                                "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
+
+                    class AssistantsV1ServiceCreatePolicyRequest
+                            # @param [description]: [String] The description of the policy.
+                            # @param [id]: [String] The Policy ID.
+                            # @param [name]: [String] The name of the policy.
+                            # @param [policy_details]: [Hash] 
+                            # @param [type]: [String] The description of the policy.
+                        attr_accessor :description, :id, :name, :policy_details, :type
+                        def initialize(payload)
+                                @description = payload["description"]
+                                @id = payload["id"]
+                                @name = payload["name"]
+                                @policy_details = payload["policy_details"]
+                                @type = payload["type"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "description": @description,
+                                "id": @id,
+                                "name": @name,
+                                "policy_details": @policy_details,
+                                "type": @type,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class AssistantsV1ServiceUpdateKnowledgeRequest
+                            # @param [description]: [String] The description of the knowledge source.
+                            # @param [knowledge_source_details]: [Hash] The details of the knowledge source based on the type.
+                            # @param [name]: [String] The name of the knowledge source.
+                            # @param [policy]: [KnowledgeList.AssistantsV1ServiceCreatePolicyRequest] 
+                            # @param [type]: [String] The description of the knowledge source.
+                            # @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,
+                                "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"
+                        
+                    end
+                    ##
+                    # Create the KnowledgeInstance
+                    # @param [AssistantsV1ServiceCreateKnowledgeRequest] assistants_v1_service_create_knowledge_request 
+                    # @return [KnowledgeInstance] Created KnowledgeInstance
+                    def create(assistants_v1_service_create_knowledge_request: nil
+                    )
+
+                        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,
+                            payload,
+                        )
+                    end
+
+                
+                    ##
+                    # Lists KnowledgeInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @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(assistant_id: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            assistant_id: assistant_id,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @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 [Enumerable] Enumerable that will yield up to limit results
+                    def stream(assistant_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            assistant_id: assistant_id,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields KnowledgeInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of KnowledgeInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] assistant_id 
+                    # @param [String] page_token PageToken provided by the API
+                    # @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)
+                        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, headers: headers)
+
+                        KnowledgePage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of KnowledgeInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of KnowledgeInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    KnowledgePage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Assistants.V1.KnowledgeList>'
+                    end
+                end
+
+
+                class KnowledgeContext < InstanceContext
+                    ##
+                    # Initialize the KnowledgeContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] id 
+                    # @return [KnowledgeContext] KnowledgeContext
+                    def initialize(version, id)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { id: id,  }
+                        @uri = "/Knowledge/#{@solution[:id]}"
+
+                        # Dependents
+                        @chunks = nil
+                        @knowledge_status = nil
+                    end
+                    ##
+                    # Delete the KnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Fetch the KnowledgeInstance
+                    # @return [KnowledgeInstance] Fetched KnowledgeInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        KnowledgeInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Update the KnowledgeInstance
+                    # @param [AssistantsV1ServiceUpdateKnowledgeRequest] assistants_v1_service_update_knowledge_request 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update(assistants_v1_service_update_knowledge_request: :unset
+                    )
+
+                        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,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Access the chunks
+                    # @return [ChunkList]
+                    # @return [ChunkContext]
+                    def chunks
+                      unless @chunks
+                        @chunks = ChunkList.new(
+                                @version, )
+                      end
+                      @chunks
+                    end
+                    ##
+                    # Access the knowledge_status
+                    # @return [KnowledgeStatusList]
+                    # @return [KnowledgeStatusContext]
+                    def knowledge_status
+                        KnowledgeStatusContext.new(
+                                @version,
+                                @solution[:id]
+                                )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Assistants.V1.KnowledgeContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Assistants.V1.KnowledgeContext #{context}>"
+                    end
+                end
+
+                class KnowledgePage < Page
+                    ##
+                    # Initialize the KnowledgePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [KnowledgePage] KnowledgePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of KnowledgeInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [KnowledgeInstance] KnowledgeInstance
+                    def get_instance(payload)
+                        KnowledgeInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Assistants.V1.KnowledgePage>'
+                    end
+                end
+                class KnowledgeInstance < InstanceResource
+                    ##
+                    # Initialize the KnowledgeInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Knowledge
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [KnowledgeInstance] KnowledgeInstance
+                    def initialize(version, payload , id: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'description' => payload['description'],
+                            'id' => payload['id'],
+                            'account_sid' => payload['account_sid'],
+                            'knowledge_source_details' => payload['knowledge_source_details'],
+                            'name' => payload['name'],
+                            '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']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'id' => id  || @properties['id']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [KnowledgeContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = KnowledgeContext.new(@version , @params['id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The type of knowledge source.
+                    def description
+                        @properties['description']
+                    end
+                    
+                    ##
+                    # @return [String] The description of knowledge.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] The details of the knowledge source based on the type.
+                    def knowledge_source_details
+                        @properties['knowledge_source_details']
+                    end
+                    
+                    ##
+                    # @return [String] The name of the knowledge source.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [String] The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The type of knowledge source ('Web', 'Database', 'Text', 'File')
+                    def type
+                        @properties['type']
+                    end
+                    
+                    ##
+                    # @return [String] The url of the knowledge resource.
+                    def url
+                        @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
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Delete the KnowledgeInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the KnowledgeInstance
+                    # @return [KnowledgeInstance] Fetched KnowledgeInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the KnowledgeInstance
+                    # @param [AssistantsV1ServiceUpdateKnowledgeRequest] assistants_v1_service_update_knowledge_request 
+                    # @return [KnowledgeInstance] Updated KnowledgeInstance
+                    def update(assistants_v1_service_update_knowledge_request: :unset
+                    )
+
+                        context.update(
+                        )
+                    end
+
+                    ##
+                    # Access the chunks
+                    # @return [chunks] chunks
+                    def chunks
+                        context.chunks
+                    end
+
+                    ##
+                    # Access the knowledge_status
+                    # @return [knowledge_status] knowledge_status
+                    def knowledge_status
+                        context.knowledge_status
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Assistants.V1.KnowledgeInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Assistants.V1.KnowledgeInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end