Module: Gcloud::Search

Defined in:

lib/gcloud/search.rb,
lib/gcloud/search/index.rb,
lib/gcloud/search/errors.rb,
lib/gcloud/search/fields.rb,
lib/gcloud/search/result.rb,
lib/gcloud/search/project.rb,
lib/gcloud/search/document.rb,
lib/gcloud/search/api_client.rb,
lib/gcloud/search/connection.rb,
lib/gcloud/search/index/list.rb,
lib/gcloud/search/credentials.rb,
lib/gcloud/search/field_value.rb,
lib/gcloud/search/result/list.rb,
lib/gcloud/search/field_values.rb,
lib/gcloud/search/document/list.rb

Overview

# Google Cloud Search

Google Cloud Search allows an application to quickly perform full-text and geo-spatial searches without having to spin up instances and without the hassle of managing and maintaining a search service.

Cloud Search provides a model for indexing documents containing structured data, with documents and indexes saved to a separate persistent store optimized for search operations. The API supports full text matching on string fields and allows indexing any number of documents in any number of indexes.

The Cloud Search API is an Alpha release, and might be changed in backward-incompatible ways. It is not currently recommended for production use. It is not subject to any SLA or deprecation policy.

## Accessing the Service

Currently, the Cloud Search API is available only to white-listed users. Contact your account manager or a member of the Google Cloud sales team if you are interested in access.

## Authentication

Authentication is handled by #search. You can provide the project and credential information to connect to the Cloud Search service, or if you are running on Google Compute Engine this configuration is taken care of for you. You can read more about the options for connecting in the [Authentication Guide](googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).

## Managing Indexes

An Index is a searchable collection of documents that belongs to a Project.

You can list the indexes in your current project:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search

indexes = search.indexes # API call indexes.each do |index|

puts index.index_id

end “‘

And you can use the project to create new indexes:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search

index = search.index “products”, skip_lookup: true “‘

A new index is an unsaved value object. Indexes cannot be created, updated, or deleted directly in the service: They are derived from the documents which are created “within” them. A new index will exist in the service once you save a document that references it.

## Managing Documents

Using an index, create a new, unsaved Document instance, providing your own unique document ID, as shown below, or omitting this argument to let the service assign the ID.

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search

index = search.index “products” document = index.document “product-sku-000001” index.find document # API call #=> nil document.rank #=> nil “‘

Add one or more fields to the document. (See [Adding document fields](#module-Gcloud::Search-label-Adding`document`fields), below.)

“‘ruby document.add “price”, 24.95 “`

When your document is complete, save it:

“‘ruby index.save document # API call document.rank # set by the server #=> 1443648166 “`

You can list the documents in an index:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “products”

documents = index.documents # API call documents.map &:doc_id #=> [“product-sku-000001”] “‘

And you can delete documents:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “products”

document = index.find “product-sku-000001”

document.delete # API call index.find document # API call #=> nil “‘

To update a document after manipulating its fields or rank, just re-save it:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “products”

document = index.find “product-sku-000001”

document.rank = 12345 document.add “price”, 9.95 # replace existing number value index.save document # API call “‘

## Adding document fields

Fields belong to documents and are the data that actually gets searched. Each field has a FieldValues collection, which facilitates access to FieldValue objects. Each FieldValue object will be saved as one of the [Cloud Search types](cloud.google.com/search/documents_indexes#document_fields_field_names_and_multi-valued_fields). The type will be inferred from the value when possible, or you can explicitly specify it by passing a symbol with the ‘type` option to Document#add.

• String (‘:atom`, `:html`, `:text`, or `:default`)

• Number (‘:number`)

• Timestamp (‘:datetime`)

• Geovalue (‘:geo`)

String values can be tokenized using one of three different types of tokenization, which can be passed with the ‘type` option when the value is added:

• ‘:atom` means “don’t tokenize this string”, treat it as one thing to compare against

• ‘:html` means “treat this string as HTML”, not comparing against the tags, and treating the rest of the content like `:text`

• ‘:text` means “treat this string as normal text” and split words apart to be compared against

Again, you can add more than one value to a field, and the values may be of different types.

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search

index = search.index “products” document = index.find “product-sku-000001” document.add “description”, “The best T-shirt ever.”, type: :text, lang: “en” document.add “description”, “<p>The best T-shirt ever.</p>”, type: :html, lang: “en” document.size #=> 2 “‘

## Searching

After populating an index with documents, you can request search results with a query:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “books”

results = index.search “dark stormy” results.each do |result|

puts result.doc_id

end “‘

By default, Result objects are sorted by document rank. For more information see the [REST API documentation for Document.rank](cloud.google.com/search/reference/rest/v1/projects/indexes/documents#resource_representation.google.cloudsearch.v1.Document.rank).

You can specify how to sort results with the ‘order` option:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “books”

results = index.search “dark stormy”, order: “published, avg_review desc” documents = index.search query # API call “‘

You can add computed fields with the ‘expressions` option, and specify the fields that are returned with the `fields` option. No document data will be returned if you omit the `fields` option, only `doc_id` references to any matched documents.

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “products”

results = index.search “cotton T-shirt”,

expressions: { total_price: "(price + tax)" },
fields: ["name", "total_price", "highlight"]

“‘

Just as in documents, Result data is accessible via Fields methods:

“‘ruby require “gcloud”

gcloud = Gcloud.new search = gcloud.search index = search.index “products” document = index.find “product-sku-000001” results = index.search “cotton T-shirt” values = results[“description”]

values #=> “100% organic cotton ruby gem T-shirt” values.type #=> :text values.lang #=> “en” values #=> “<p>100% organic cotton ruby gem T-shirt</p>” values.type #=> :html values.lang #=> “en” “‘

Defined Under Namespace

Classes: APIClient, ApiError, Connection, Credentials, Document, Error, FieldValue, FieldValues, Fields, Index, Project, Result