relevanceai

Subpackages

• relevanceai.api
  • relevanceai.api.batch
    • relevanceai.api.batch.batch_insert
    • relevanceai.api.batch.batch_retrieve
    • relevanceai.api.batch.chunk
    • relevanceai.api.batch.local_logger
    • relevanceai.api.batch.mongo_to_relevance_ai
  • relevanceai.api.endpoints
    • relevanceai.api.endpoints.admin
    • relevanceai.api.endpoints.aggregate
    • relevanceai.api.endpoints.centroids
    • relevanceai.api.endpoints.client
    • relevanceai.api.endpoints.cluster
    • relevanceai.api.endpoints.datasets
    • relevanceai.api.endpoints.documents
    • relevanceai.api.endpoints.encoders
    • relevanceai.api.endpoints.monitor
    • relevanceai.api.endpoints.prediction
    • relevanceai.api.endpoints.recommend
    • relevanceai.api.endpoints.search
    • relevanceai.api.endpoints.services
    • relevanceai.api.endpoints.tagger
    • relevanceai.api.endpoints.tasks
    • relevanceai.api.endpoints.wordclouds
  • relevanceai.api.client
  • relevanceai.api.requests_config
• relevanceai.vector_tools
  • relevanceai.vector_tools.client
  • relevanceai.vector_tools.cluster
  • relevanceai.vector_tools.cluster_evaluate
  • relevanceai.vector_tools.constants
  • relevanceai.vector_tools.dim_reduction
  • relevanceai.vector_tools.nearest_neighbours
  • relevanceai.vector_tools.plot_text_theme_model
• relevanceai.visualise
  • relevanceai.visualise.dash_components
    • relevanceai.visualise.dash_components.components
    • relevanceai.visualise.dash_components.sections
    • relevanceai.visualise.dash_components.app
    • relevanceai.visualise.dash_components.callbacks
  • relevanceai.visualise.projector

Submodules

• relevanceai.base
• relevanceai.concurrency
• relevanceai.config
• relevanceai.dashboard_mappings
• relevanceai.datasets
• relevanceai.errors
• relevanceai.http_client
• relevanceai.logger
• relevanceai.progress_bar
• relevanceai.transport
• relevanceai.utils

Package Contents

Classes

Client

Python Client for Relevance AI's relevanceai

Attributes

__version__
pypi_data

class relevanceai.Client(project=os.getenv('RELEVANCE_PROJECT'), api_key=os.getenv('RELEVANCE_API_KEY'), authenticate: bool = False)

Bases: relevanceai.api.client.BatchAPIClient, doc_utils.doc_utils.DocUtils

Python Client for Relevance AI’s relevanceai

FAIL_MESSAGE = Your API key is invalid. Please login again

_cred_fn = .creds.json

build_and_plot_clusters

property base_url(self)

property base_ingest_url(self)

_token_to_auth(self)

_write_credentials(self, project, api_key)

_read_credentials(self)

login(self, authenticate: bool = True)

Preferred login method for demos and interactive usage.

property auth_header(self)

make_search_suggestion(self)

check_auth(self)

relevanceai.__version__ = 0.25.1

relevanceai.pypi_data