Integrations

Browse and View Your Integrations in Code

Note: Integrations currently must be created through the VectorShift website, but you can still interact with and use your integrations via the SDK.

Similar to other VectorShift objects, interacting with integrations also requires API keys. If the API keys have already been set as environment variables, they do not need to be supplied in those methods. The output of all methods invoking APIs is a dictionary representing the API JSON response.

vectorshift.integration.Integration(
    id: str,
    name: str = '',
    description: str = '',
    type: str = '',
)

Represents an integration object. Note: To work with Integration objects, we suggest using the fetch and fetch_all methods instead.

Arguments:

• id: The id of the integration.

• name: The name of the integration.

• description: A brief description of the Vector Store.

• type: The type of integration you are working with.

fetch_all(
    api_key: str = None, 
)

A method fetch all the integrations you have in your account.

Arguments:

• api_key: The VectorShift API key.

fetch(
    integration_id: Optional[str] = None,
    integration_name: Optional[str] = None,
    api_key: str = None, 
)

A method to fetch a specific integration.

Arguments:

• integration_id: The id of the integration

• integration_name: The name of the integration you want to fetch

• api_key: The VectorShift API key.

sync_metadata(
    api_key: str = None, 
)

A method that syncs the metadata associated with an integration. Integration metadata is how VectorShift keeps track of what resources are available for each integration.

Arguments:

• shared_users: A list of emails to share the Vector Store with.

• api_key: The VectorShift API key.

sync_integration(
    api_key: str = None, 
)

A method to sync all the documents in all vector stores that contain the associated integration.

Arguments:

• api_key: The VectorShift API key.