Module: Elastic::WorkplaceSearch::Client::ContentSourceDocuments

Included in:
Elastic::WorkplaceSearch::Client
Defined in:
lib/elastic/workplace-search/client/content_source_documents.rb

Instance Method Summary collapse

Instance Method Details

#destroy_documents(content_source_key, document_ids) ⇒ Array<Hash>

Destroy a batch of documents given a list of external IDs

Parameters:

  • document_ids (Array<String>) —

    an Array of Document External IDs

Returns:

  • (Array<Hash>) —

    an Array of Document destroy result hashes

Raises:

  • (Timeout::Error) —

    when timeout expires waiting for results



28
29
30
31
 
# File 'lib/elastic/workplace-search/client/content_source_documents.rb', line 28

def destroy_documents(content_source_key, document_ids)
  document_ids = Array(document_ids)
  post("sources/#{content_source_key}/documents/bulk_destroy.json", document_ids)
end

#index_documents(content_source_key, documents) ⇒ Array<Hash>

Index a batch of documents.

Parameters:

  • content_source_key (String) —

    the unique Content Source key as found in your Content Sources dashboard

  • documents (Array) —

    an Array of Document Hashes

Returns:

  • (Array<Hash>) —

    an Array of Document indexing Results

Raises:



15
16
17
18
19
 
# File 'lib/elastic/workplace-search/client/content_source_documents.rb', line 15

def index_documents(content_source_key, documents)
  documents = Array(documents).map! { |document| normalize_document(document) }

  async_create_or_update_documents(content_source_key, documents)
end