You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/generated/api/collectionsApi.ts
+59-12Lines changed: 59 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
/**
2
2
* Search.io API
3
-
* Search.io offers a search and discovery service with Neuralsearch®, the world\'s first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence.
3
+
* Search.io offers a search and discovery service with Neuralsearch®, the world\'s first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence. # Authentication <!-- ReDoc-Inject: <SecurityDefinitions> --> # Rate limiting The Search.io API employs a number of safeguards against bursts of incoming traffic to help maximize its stability. Users who send many requests in quick succession may see error responses that show up as HTTP status code `429`. For the [UpsertRecord](/docs/api#operation/UpsertRecord) call, Search.io allows up to 175 write operations per second. Treat these limits as maximums and don\'t generate unnecessary load. See [Handling limiting gracefully](/docs/api/#section/Rate-limiting/Handling-limiting-gracefully) for advice on handling `429`s. We may reduce limits to prevent abuse. ## Common causes and mitigations Rate limiting can occur under a variety of conditions, but it\'s most common in these scenarios: - Running a large volume of closely-spaced requests. Often this is part of a user\'s long-running reindex job. When engaging in these activities, you should try to control the request rate (see [Handling limiting gracefully](/docs/api/#section/Rate-limiting/Handling-limiting-gracefully)). - Running batch operations in parallel. Often [BatchUpsertRecords](/docs/api#operation/BatchUpsertRecords) is used as part of a user\'s long-running reindex job. A batch of records of size `N` passed to [BatchUpsertRecords](/docs/api#operation/BatchUpsertRecords) is counted as `N` [UpsertRecord](/docs/api#operation/UpsertRecord) calls for the purposes of rate limiting, as opposed to a single call. Treat batch API calls as a convenience rather than a way to get more write throughput. ## Handling limiting gracefully A basic technique for integrations to gracefully handle limiting is to watch for `429` HTTP status codes and build in a retry mechanism. The retry mechanism should follow an exponential backoff schedule to reduce request volume when necessary. We also recommend building some randomness into the backoff schedule to avoid a [thundering herd effect](https://en.wikipedia.org/wiki/Thundering_herd_problem).
4
4
*
5
-
* The version of the OpenAPI document: v4
5
+
* The version of the OpenAPI document: 4.0.0
6
6
* Contact: support@search.io
7
7
*
8
8
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -122,10 +122,12 @@ export class CollectionsApi {
122
122
* @summary Create collection
123
123
* @param collectionId The ID to use for the collection. This must start with an alphanumeric character followed by one or more alphanumeric or `-` characters. Strictly speaking, it must match the regular expression: `^[A-Za-z][A-Za-z0-9\\-]*$`.
124
124
* @param collection Details of the collection to create.
125
+
* @param accountId The account that owns the collection, e.g. `1618535966441231024`.
@@ -441,9 +453,13 @@ export class CollectionsApi {
441
453
* Retrieve the details of a collection.
442
454
* @summary Get collection
443
455
* @param collectionId The collection to retrieve, e.g. `my-collection`.
456
+
* @param accountId The account that owns the collection, e.g. `1618535966441231024`.
457
+
* @param view The amount of information to include in the retrieved pipeline. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage.
@@ -539,12 +566,16 @@ export class CollectionsApi {
539
566
/**
540
567
* Retrieve a list of collections in an account.
541
568
* @summary List collections
569
+
* @param accountId The account that owns this set of collections, e.g. `1618535966441231024`.
542
570
* @param pageSize The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections are returned. The maximum value is 100; values above 100 are coerced to 100.
543
571
* @param pageToken A page token, received from a previous [ListCollections](/docs/api#operation/ListCollections) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [ListCollections](/docs/api#operation/ListCollections) must match the call that provided the page token.
572
+
* @param view The amount of information to include in each retrieved collection. - BASIC: Include basic information including display name and domains. This is the default value (for both [ListCollections](/docs/api#operation/ListCollections) and [GetCollection](/docs/api#operation/GetCollection)). - FULL: Include the information from `BASIC`, plus full collection details like disk usage.
@@ -651,10 +693,12 @@ export class CollectionsApi {
651
693
* @summary Query collection
652
694
* @param collectionId The collection to query, e.g. `my-collection`.
653
695
* @param queryCollectionRequest
696
+
* @param accountId The account that owns the collection, e.g. `1618535966441231024`. Unlike other API calls, the `QueryCollection` call can be called from a browser. When called from a browser, the `Account-Id` header must be set to your account ID.
* Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects Note: You must pass an `Account-Id` header.
942
+
* Track an analytics event when a user interacts with an object returned by a [QueryCollection](/docs/api/#operation/QueryCollection) request. An analytics event can be tracked for the following objects: - Results - Promotion banners - Redirects When tracking redirect events, set `type` to `redirect`. - **Note:** You must pass an `Account-Id` header. - **Note:** One of `result_id`, `banner_id` or `redirect_id` are required.
895
943
* @summary Track event
896
944
* @param accountId The account that owns the collection, e.g. `1618535966441231024`.
897
945
* @param collectionId The collection to track the event against, e.g. `my-collection`.
@@ -1016,13 +1064,15 @@ export class CollectionsApi {
1016
1064
* Update the details of a collection.
1017
1065
* @summary Update collection
1018
1066
* @param collectionId The collection to update, e.g. `my-collection`.
1019
-
* @param updateMask The list of fields to be updated, separated by a comma, e.g. `field1,field2`. Each field should be in snake case, e.g. `display_name`. For each field that you want to update, provide a corresponding value in the collection object containing the new value.
1020
1067
* @param collection The details of the collection to update.
1068
+
* @param accountId The account that owns the collection, e.g. `1618535966441231024`.
1069
+
* @param updateMask The list of fields to update, separated by a comma, e.g. `authorized_query_domains,display_name`. Each field should be in snake case. For each field that you want to update, provide a corresponding value in the collection object containing the new value.
0 commit comments