Class: RelevancedClient::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/relevanced_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(host, port) ⇒ Client

Returns a new instance of Client.



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/relevanced_client.rb', line 11

def initialize(host, port)
    @host = host
    @port = port
    @thrift_transport = Thrift::BufferedTransport.new(
        Thrift::Socket.new(host, port)
    )
    @thrift_protocol = Thrift::BinaryProtocol.new(
        @thrift_transport
    )
    @thrift_client = Relevanced::Client.new(@thrift_protocol)
    @thrift_transport.open()
end

Instance Method Details

#add_document_to_centroid(centroid_id, document_id, ignore_already_in_centroid = false) ⇒ Object 



24
25
26
 
# File 'lib/relevanced_client.rb', line 24

def add_document_to_centroid(centroid_id, document_id, ignore_already_in_centroid=false)
    add_documents_to_centroid(centroid_id, [document_id], ignore_already_in_centroid)
end

#add_documents_to_centroid(centroid_id, document_ids, ignore_already_in_centroid = false) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/relevanced_client.rb', line 28

def add_documents_to_centroid(centroid_id, document_ids, ignore_already_in_centroid=false)
    request = AddDocumentsToCentroidRequest.new
    request.centroidId = centroid_id
    request.documentIds = document_ids
    request.ignoreAlreadyInCentroid = ignore_already_in_centroid
    @thrift_client.addDocumentsToCentroid(request)
end

#create_centroid(centroid_id, ignore_existing = false) ⇒ Object 



64
65
66
67
68
69
 
# File 'lib/relevanced_client.rb', line 64

def create_centroid(centroid_id, ignore_existing=false)
    request = CreateCentroidRequest.new
    request.id = centroid_id
    request.ignoreExisting = ignore_existing
    @thrift_client.createCentroid(request)
end

#create_document(text, lang = Language::EN) ⇒ Object 



36
37
38
 
# File 'lib/relevanced_client.rb', line 36

def create_document(text, lang=Language::EN)
    @thrift_client.createDocument(text, lang)
end

#create_document_with_id(document_id, text, lang = Language::EN) ⇒ Object 



40
41
42
43
44
 
# File 'lib/relevanced_client.rb', line 40

def create_document_with_id(document_id, text, lang=Language::EN)
    @thrift_client.createDocumentWithID(
        document_id, text, lang
    )
end

#delete_centroid(centroid_id, ignore_missing = false) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/relevanced_client.rb', line 71

def delete_centroid(centroid_id, ignore_missing=false)
    request = DeleteCentroidRequest.new
    request.id = centroid_id
    request.ignoreMissing = ignore_missing
    @thrift_client.deleteCentroid(request)
end

#delete_document(document_id, ignore_missing = false) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/relevanced_client.rb', line 78

def delete_document(document_id, ignore_missing=false)
    request = DeleteDocumentRequest.new
    request.id = document_id
    request.ignoreMissing = ignore_missing
    @thrift_client.deleteDocument(request)
end

#get_centroid_similarity(centroid_1_id, centroid_2_id) ⇒ Object 



50
51
52
53
54
 
# File 'lib/relevanced_client.rb', line 50

def get_centroid_similarity(centroid_1_id, centroid_2_id)
    @thrift_client.getCentroidSimilarity(
        centroid_1_id, centroid_2_id
    )
end

#get_document_similarity(centroid_id, document_id) ⇒ Object 



56
57
58
 
# File 'lib/relevanced_client.rb', line 56

def get_document_similarity(centroid_id, document_id)
    @thrift_client.getDocumentSimilarity(centroid_id, document_id)
end

#get_server_metadata ⇒ Object 



46
47
48
 
# File 'lib/relevanced_client.rb', line 46

def get_server_metadata()
    @thrift_client.getServerMetadata()
end

#get_text_similarity(centroid_id, text, lang = Language::EN) ⇒ Object 



60
61
62
 
# File 'lib/relevanced_client.rb', line 60

def get_text_similarity(centroid_id, text, lang=Language::EN)
    @thrift_client.getTextSimilarity(centroid_id, text, lang)
end

#join_centroid(centroid_id) ⇒ Object 



85
86
87
88
89
 
# File 'lib/relevanced_client.rb', line 85

def join_centroid(centroid_id)
    request = JoinCentroidRequest.new
    request.id = centroid_id
    @thrift_client.joinCentroid(request)
end

#list_all_centroids ⇒ Object 



130
131
132
 
# File 'lib/relevanced_client.rb', line 130

def list_all_centroids()
    @thrift_client.listAllCentroids()
end

#list_all_documents ⇒ Object 



134
135
136
 
# File 'lib/relevanced_client.rb', line 134

def list_all_documents()
    @thrift_client.listAllDocuments()
end

#list_all_documents_for_centroid(centroid_id) ⇒ Object 



138
139
140
 
# File 'lib/relevanced_client.rb', line 138

def list_all_documents_for_centroid(centroid_id)
    @thrift_client.listAllDocumentsForCentroid(centroid_id)
end

#list_centroid_document_range(centroid_id, offset, count) ⇒ Object 



142
143
144
 
# File 'lib/relevanced_client.rb', line 142

def list_centroid_document_range(centroid_id, offset, count)
    @thrift_client.listCentroidDocumentRange(centroid_id, offset, count)
end

#list_centroid_document_range_from_id(centroid_id, document_id, count) ⇒ Object 



146
147
148
 
# File 'lib/relevanced_client.rb', line 146

def list_centroid_document_range_from_id(centroid_id, document_id, count)
    @thrift_client.listCentroidDocumentRangeFromID(centroid_id, document_id, count)
end

#list_centroid_range(offset, count) ⇒ Object 



151
152
153
 
# File 'lib/relevanced_client.rb', line 151

def list_centroid_range(offset, count)
    @thrift_client.listCentroidRange(offset, count)
end

#list_centroid_range_from_id(centroid_id, count) ⇒ Object 



155
156
157
 
# File 'lib/relevanced_client.rb', line 155

def list_centroid_range_from_id(centroid_id, count)
    @thrift_client.listCentroidRangeFromID(centroid_id, count)
end

#list_document_range(offset, count) ⇒ Object 



159
160
161
 
# File 'lib/relevanced_client.rb', line 159

def list_document_range(offset, count)
    @thrift_client.listDocumentRange(offset, count)
end

#list_document_range_from_id(document_id, count) ⇒ Object 



163
164
165
 
# File 'lib/relevanced_client.rb', line 163

def list_document_range_from_id(document_id, count)
    @thrift_client.listDocumentRangeFromID(document_id, count)
end

#list_unused_documents(limit) ⇒ Object 



167
168
169
 
# File 'lib/relevanced_client.rb', line 167

def list_unused_documents(limit)
    @thrift_client.listUnusedDocuments(limit)
end

#multi_create_centroids(centroid_ids, ignore_existing = false) ⇒ Object 



91
92
93
94
95
96
 
# File 'lib/relevanced_client.rb', line 91

def multi_create_centroids(centroid_ids, ignore_existing=false)
    request = MultiCreateCentroidsRequest.new
    request.ids = centroid_ids
    request.ignoreExisting = ignore_existing
    @thrift_client.multiCreateCentroids(request)
end

#multi_delete_centroids(centroid_ids, ignore_missing = false) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/relevanced_client.rb', line 98

def multi_delete_centroids(centroid_ids, ignore_missing=false)
    request = MultiDeleteCentroidsRequest.new
    request.ids = centroid_ids
    request.ignoreMissing = ignore_missing
    @thrift_client.multiDeleteCentroids(request)
end

#multi_delete_documents(document_ids, ignore_missing = false) ⇒ Object 



105
106
107
108
109
110
 
# File 'lib/relevanced_client.rb', line 105

def multi_delete_documents(document_ids, ignore_missing=false)
    request = MultiDeleteDocumentsRequest.new
    request.ids = document_ids
    request.ignoreMissing = ignore_missing
    @thrift_client.multiDeleteDocuments(request)
end

#multi_get_document_similarity(centroid_id_list, document_id) ⇒ Object 



112
113
114
115
116
 
# File 'lib/relevanced_client.rb', line 112

def multi_get_document_similarity(centroid_id_list, document_id)
    @thrift_client.multiGetDocumentSimilarity(
        centroid_id_list, document_id
    )
end

#multi_get_text_similarity(centroid_id_list, text, lang = Language::EN) ⇒ Object 



118
119
120
121
122
 
# File 'lib/relevanced_client.rb', line 118

def multi_get_text_similarity(centroid_id_list, text, lang=Language::EN)
    @thrift_client.multiGetTextSimilarity(
        centroid_id_list, text, lang
    )
end

#multi_join_centroids(centroid_ids) ⇒ Object 



124
125
126
127
128
 
# File 'lib/relevanced_client.rb', line 124

def multi_join_centroids(centroid_ids)
    request = MultiJoinCentroidsRequest.new
    request.ids = centroid_ids
    @thrift_client.multiJoinCentroids(request)
end

#ping ⇒ Object 



171
172
173
 
# File 'lib/relevanced_client.rb', line 171

def ping()
    @thrift_client.ping()
end

#remove_document_from_centroid(centroid_id, document_id, ignore_not_in_centroid = false) ⇒ Object 



175
176
177
 
# File 'lib/relevanced_client.rb', line 175

def remove_document_from_centroid(centroid_id, document_id, ignore_not_in_centroid=false)
    remove_documents_from_centroid(centroid_id, [document_id], ignore_not_in_centroid)
end

#remove_documents_from_centroid(centroid_id, document_ids, ignore_not_in_centroid = false) ⇒ Object 



179
180
181
182
183
184
185
 
# File 'lib/relevanced_client.rb', line 179

def remove_documents_from_centroid(centroid_id, document_ids, ignore_not_in_centroid=false)
    request = RemoveDocumentsFromCentroidRequest.new
    request.centroidId = centroid_id
    request.documentIds = document_ids
    request.ignoreNotInCentroid = ignore_not_in_centroid
    @thrift_client.removeDocumentsFromCentroid(request)
end