GBDX

Lesson: Vector Services Index Searching

The workflow of API requests in which a user sends when using the Vector Services

Index General Search by Term

Index General Search works the same way as the standard General Search by Term.

For more information on querying and query construction, check the Query Syntax, Fields, and Item Type Suffixes page and Vector Services Example Query Constructions page.

Step 1: List Vector Items OR Get Paging ID

Since the user already has an idea of what they are searching for, they can immediately begin the process of gaining the actual vector items. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply get the vector items in one go. This request does allow the user to either retrieve the vectors with the default fields, or the user can select the fields to return.

However, if there are more than 1000 vector items to retrieve, the user must use paging to retrieve the results. The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the count parameter.

For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.

Step 2: Retrieve Page of Vector Items

After acquiring the paging ID, the user can then begin paging requests to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow both steps to acquire everything they need from the Vector Services.

Step 3: Download Vector Items

If the user is satisfied with what they see in the retrieved vector items based on their query, the user is able to download the vector items as json for use in other applications.

Note: There is no vector index download option at this point; user will be working with the standard download api.

Index Shape Search by Term

Index Shape Search works the same way as the standard Shape Search by Term.

For more information on querying and query construction, check the Query Syntax, Fields, and Item Type Suffixes page and Vector Services Example Query Constructions page.

Step 1: List Vector Items OR Get Paging ID

Since the user already has an idea of what they are searching for, they can immediately begin the process of gaining the actual vector items. This process is split based on several factors. The first of which is a division based on the number of vector items to retrieve; if there are less than 1000 vector items, the user can safely run a request to simply get the vector items in one go.

However, if there are more than 1000 vector items to retrieve, the user must use paging to retrieve the results. The List Vector Items api call is restricted to 1000 items or less, regardless of whether the user includes the count parameter.

For simplicity, if the user is unsure of whether there are less than 1000 vector items to retrieve, it is best to use the paging request instead.

Step 2: Retrieve Page of Vector Items

After acquiring the paging ID, the user can then begin paging requests to retrieve all of the resulting vector items they want. Paging is the preferred method of returning vector items, and more often than not the user will need to follow both steps to acquire everything they need from the Vector Services.