sajari_client.RecordsApi

All URIs are relative to https://api.search.io

Method	HTTP request	Description
batch_update_records	POST /v4/collections/{collection_id}/records:batchUpdate	Batch update records
batch_upsert_records	POST /v4/collections/{collection_id}/records:batchUpsert	Batch upsert records
delete_record	POST /v4/collections/{collection_id}/records:delete	Delete record
get_record	POST /v4/collections/{collection_id}/records:get	Get record
update_record	POST /v4/collections/{collection_id}/records:update	Update record
upsert_record	POST /v4/collections/{collection_id}/records:upsert	Upsert record

batch_update_records

BatchUpdateRecordsResponse batch_update_records(collection_id, batch_update_records_request)

Batch update records

The batch version of the UpdateRecord call. You cannot run batches in parallel. Your code must wait for previous calls to BatchUpdateRecords to complete before making subsequent calls. A maximum of 200 records can be updated in a batch.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.batch_update_records_request import BatchUpdateRecordsRequest
from sajari_client.model.error import Error
from sajari_client.model.batch_update_records_response import BatchUpdateRecordsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection that contains the records to update, e.g. `my-collection`.
    batch_update_records_request = BatchUpdateRecordsRequest(
        requests=[
            UpdateRecordRequest(
                key=RecordKey(
                    field="field_example",
                    value="value_example",
                ),
                record={
                    "key": {},
                },
                update_mask="update_mask_example",
            ),
        ],
        update_mask="update_mask_example",
    ) # BatchUpdateRecordsRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Batch update records
        api_response = api_instance.batch_update_records(collection_id, batch_update_records_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->batch_update_records: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Batch update records
        api_response = api_instance.batch_update_records(collection_id, batch_update_records_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->batch_update_records: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection that contains the records to update, e.g. `my-collection`.
batch_update_records_request	BatchUpdateRecordsRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

BatchUpdateRecordsResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batch_upsert_records

BatchUpsertRecordsResponse batch_upsert_records(collection_id, batch_upsert_records_request)

Batch upsert records

The batch version of the UpsertRecord call. You cannot run batches in parallel. Your code must wait for previous calls to BatchUpsertRecords to complete before making subsequent calls. A maximum of 200 records can be upserted in a batch.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.batch_upsert_records_request import BatchUpsertRecordsRequest
from sajari_client.model.batch_upsert_records_response import BatchUpsertRecordsResponse
from sajari_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection to upsert the records in, e.g. `my-collection`.
    batch_upsert_records_request = BatchUpsertRecordsRequest(
        pipeline=BatchUpsertRecordsRequestPipeline(
            name="name_example",
            version="version_example",
        ),
        records=[
            {},
        ],
        variables={
            "key": None,
        },
    ) # BatchUpsertRecordsRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Batch upsert records
        api_response = api_instance.batch_upsert_records(collection_id, batch_upsert_records_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->batch_upsert_records: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Batch upsert records
        api_response = api_instance.batch_upsert_records(collection_id, batch_upsert_records_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->batch_upsert_records: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection to upsert the records in, e.g. `my-collection`.
batch_upsert_records_request	BatchUpsertRecordsRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

BatchUpsertRecordsResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_record

bool, date, datetime, dict, float, int, list, str, none_type delete_record(collection_id, delete_record_request)

Delete record

Delete a record with the given key. If you receive "service unavailable" errors, the collection may be in read only mode. This is indicated by a COLLECTION_READ_ONLY reason inside the error details. The following snippet shows the JSON response for a collection read only error. json { \"code\": 14, \"message\": \"read only\", \"details\": [ { \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\", \"reason\": \"COLLECTION_READ_ONLY\" } ] } If you encounter this error you should retry your call. Your app can use the Retry-After HTTP header to know when to retry.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.delete_record_request import DeleteRecordRequest
from sajari_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection that contains the record to delete, e.g. `my-collection`.
    delete_record_request = DeleteRecordRequest(
        key=RecordKey(
            field="field_example",
            value="value_example",
        ),
    ) # DeleteRecordRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Delete record
        api_response = api_instance.delete_record(collection_id, delete_record_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->delete_record: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Delete record
        api_response = api_instance.delete_record(collection_id, delete_record_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->delete_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection that contains the record to delete, e.g. `my-collection`.
delete_record_request	DeleteRecordRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_record

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_record(collection_id, get_record_request)

Get record

Retrieve a record with the given key.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.get_record_request import GetRecordRequest
from sajari_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection that contains the record to retrieve, e.g. `my-collection`.
    get_record_request = GetRecordRequest(
        key=RecordKey(
            field="field_example",
            value="value_example",
        ),
    ) # GetRecordRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get record
        api_response = api_instance.get_record(collection_id, get_record_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->get_record: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get record
        api_response = api_instance.get_record(collection_id, get_record_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->get_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection that contains the record to retrieve, e.g. `my-collection`.
get_record_request	GetRecordRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_record

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_record(collection_id, update_record_request)

Update record

Add or update specific fields within a record with the given values. The updated record is returned in the response. To replace all fields in a record, you should use the UpsertRecord call. Note that the update record call cannot be used to add or update indexed or unique fields. For this case use the UpsertRecord call. If you receive "service unavailable" errors, the collection may be in read only mode. This is indicated by a COLLECTION_READ_ONLY reason inside the error details. The following snippet shows the JSON response for a collection read only error. json { \"code\": 14, \"message\": \"read only\", \"details\": [ { \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\", \"reason\": \"COLLECTION_READ_ONLY\" } ] } If you encounter this error you should retry your call. Your app can use the Retry-After HTTP header to know when to retry.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.update_record_request import UpdateRecordRequest
from sajari_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection that contains the record to update, e.g. `my-collection`.
    update_record_request = UpdateRecordRequest(
        key=RecordKey(
            field="field_example",
            value="value_example",
        ),
        record={
            "key": {},
        },
        update_mask="update_mask_example",
    ) # UpdateRecordRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update record
        api_response = api_instance.update_record(collection_id, update_record_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->update_record: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update record
        api_response = api_instance.update_record(collection_id, update_record_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->update_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection that contains the record to update, e.g. `my-collection`.
update_record_request	UpdateRecordRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upsert_record

UpsertRecordResponse upsert_record(collection_id, upsert_record_request)

Upsert record

If the record does not exist in the collection it is inserted. If it does exist it is updated. If no pipeline is specified, the default record pipeline is used to process the record. If the record is inserted, the response contains the key of the inserted record. You can use this if you need to retrieve or delete the record. If the record is updated, the response does not contain a key. Callers can use this as a signal to determine if the record is inserted/created or updated. For example, to add a single product from your ecommerce store to a collection, use the following call: json { \"pipeline\": { \"name\": \"my-pipeline\", \"version\": \"1\" }, \"record\": { \"id\": \"54hdc7h2334h\", \"name\": \"Smart TV\", \"price\": 1999, \"brand\": \"Acme\", \"description\": \"...\", \"in_stock\": true } } If you receive "service unavailable" errors, the collection may be in read only mode. This is indicated by a COLLECTION_READ_ONLY reason inside the error details. The following snippet shows the JSON response for a collection read only error. json { \"code\": 14, \"message\": \"read only\", \"details\": [ { \"@type\": \"type.googleapis.com/google.rpc.ErrorInfo\", \"reason\": \"COLLECTION_READ_ONLY\" } ] } If you encounter this error you should retry your call. Your app can use the Retry-After HTTP header to know when to retry.

Example

Basic Authentication (BasicAuth):

import time
import sajari_client
from sajari_client.api import records_api
from sajari_client.model.upsert_record_request import UpsertRecordRequest
from sajari_client.model.upsert_record_response import UpsertRecordResponse
from sajari_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.search.io
# See configuration.py for a list of all supported configuration parameters.
configuration = sajari_client.Configuration(
    host = "https://api.search.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = sajari_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with sajari_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = records_api.RecordsApi(api_client)
    collection_id = "collection_id_example" # str | The collection to upsert the record in, e.g. `my-collection`.
    upsert_record_request = UpsertRecordRequest(
        pipeline=UpsertRecordRequestPipeline(
            name="name_example",
            version="version_example",
        ),
        record={},
        variables={
            "key": None,
        },
    ) # UpsertRecordRequest | 
    account_id = "Account-Id_example" # str | The account that owns the collection, e.g. `1618535966441231024`. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Upsert record
        api_response = api_instance.upsert_record(collection_id, upsert_record_request)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->upsert_record: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Upsert record
        api_response = api_instance.upsert_record(collection_id, upsert_record_request, account_id=account_id)
        pprint(api_response)
    except sajari_client.ApiException as e:
        print("Exception when calling RecordsApi->upsert_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
collection_id	str	The collection to upsert the record in, e.g. `my-collection`.
upsert_record_request	UpsertRecordRequest
account_id	str	The account that owns the collection, e.g. `1618535966441231024`.	[optional]

Return type

UpsertRecordResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
401	Returned when the request does not have valid authentication credentials.	-
403	Returned when the user does not have permission to access the resource.	-
404	Returned when the resource does not exist.	-
500	Returned when the API encounters an internal error.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

RecordsApi.md

Latest commit

History

RecordsApi.md

File metadata and controls

sajari_client.RecordsApi

batch_update_records

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batch_upsert_records

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

upsert_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details