class ApiAiWrapper::Trainers::EntityTrainer

api.ai/docs/reference/agent/entities#overview api.ai/docs/reference/agent/entities#entity_object

Public Instance Methods

delete_entity(eid) click to toggle source

api.ai/docs/reference/agent/entities#delete_entitieseid Delete an entity eid can either be the ID or the entity NAME

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 65
def delete_entity(eid)
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")

  self.delete(endpoint_url, {})
end
delete_entity_entries(eid, entries) click to toggle source

api.ai/docs/reference/agent/entities#delete_entitieseidentries Delete an entity’s entries eid can either be the ID or the entity NAME entries is an array of reference values (e.g. [“blue”, “red”] for entity “color”)

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 75
def delete_entity_entries(eid, entries)
  body = { entries: entries }
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")

  self.delete(endpoint_url, body.to_json)
end
get_entities() click to toggle source

api.ai/docs/reference/agent/entities#get_entities Retrieves all entities for a given token

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 9
def get_entities
  endpoint_url = URI.join(self.engine.base_url, "entities?v=#{self.engine.version}")

  self.get(endpoint_url, {})
end
get_entity(eid) click to toggle source

api.ai/docs/reference/agent/entities#get_entitieseid Retrieves entity info eid can either be the ID or the entity NAME

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 18
def get_entity(eid)
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")

  self.get(endpoint_url, {})
end
post_entity(name, entries) click to toggle source

docs.api.ai/docs/entities#post-entities Creates an entity with the corresponding entries

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 26
def post_entity(name, entries)
  body = {
    name: name,
    entries: entries
  }
  endpoint_url = URI.join(self.engine.base_url, "entities?v=#{self.engine.version}")

  self.post(endpoint_url, body.to_json)
end
post_entity_entries(eid, entries) click to toggle source

api.ai/docs/reference/agent/entities#post_entitieseidentries Allows to add entries to en existing entity eid can either be the ID or the entity NAME

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 39
def post_entity_entries(eid, entries)
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")

  self.post(endpoint_url, entries.to_json)
end
put_entity(eid, options = {}) click to toggle source

api.ai/docs/reference/agent/entities#put_entitieseid Update an entity

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 47
def put_entity(eid, options = {})
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")

  self.put(endpoint_url, options.to_json)
end
put_entity_entries(eid, entries) click to toggle source

api.ai/docs/reference/agent/entities#put_entitieseid Update an entity’s entries

# File lib/api_ai_wrapper/trainers/entity_trainer.rb, line 55
def put_entity_entries(eid, entries)
  body = { entries: entries }
  endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")

  self.put(endpoint_url, entries.to_json)
end