Skip to main content

Clarifai gRPC API Client

Project description

image

Clarifai Python gRPC Client

This is the official Clarifai gRPC Python client for interacting with our powerful recognition API. Clarifai provides a platform for data scientists, developers, researchers and enterprises to master the entire artificial intelligence lifecycle. Gather valuable business insights from images, video and text using computer vision and natural language processing.

PyPI version Build

Installation

python -m pip install clarifai-grpc

Versioning

This library doesn't use semantic versioning. The first two version numbers (X.Y out of X.Y.Z) follow the API (backend) versioning, and whenever the API gets updated, this library follows it.

The third version number (Z out of X.Y.Z) is used by this library for any independent releases of library-specific improvements and bug fixes.

Getting started

Construct the V2Stub object using which you'll access all the Clarifai API functionality:

from clarifai_grpc.channel.clarifai_channel import ClarifaiChannel
from clarifai_grpc.grpc.api import service_pb2_grpc

stub = service_pb2_grpc.V2Stub(ClarifaiChannel.get_grpc_channel())

Alternatives to the encrypted gRPC channel (ClarifaiChannel.get_grpc_channel()) are:

  • the HTTPS+JSON channel (ClarifaiChannel.get_json_channel()), and
  • the unencrypted gRPC channel (ClarifaiChannel.get_insecure_grpc_channel()).

We only recommend them in special cases.

Predict concepts in an image:

from clarifai_grpc.grpc.api import service_pb2, resources_pb2
from clarifai_grpc.grpc.api.status import status_code_pb2

YOUR_CLARIFAI_API_KEY = "???"
YOUR_APPLICATION_ID = "???"
SAMPLE_URL = "https://samples.clarifai.com/metro-north.jpg"

# This is how you authenticate.
metadata = (("authorization", f"Key {YOUR_CLARIFAI_API_KEY}"),)

request = service_pb2.PostModelOutputsRequest(
    # This is the model ID of a publicly available General model. You may use any other public or custom model ID.
    model_id="general-image-recognition",
    user_app_id=resources_pb2.UserAppIDSet(app_id=YOUR_APPLICATION_ID),
    inputs=[
        resources_pb2.Input(
            data=resources_pb2.Data(image=resources_pb2.Image(url=SAMPLE_URL))
        )
    ],
)
response = stub.PostModelOutputs(request, metadata=metadata)

if response.status.code != status_code_pb2.SUCCESS:
    print(response)
    raise Exception(f"Request failed, status code: {response.status}")

for concept in response.outputs[0].data.concepts:
    print("%12s: %.2f" % (concept.name, concept.value))

See the Clarifai API documentation for all available functionality.

Troubleshooting

I get the following error when installing the library: Failed building wheel for grpcio

Try upgrading setuptools to a version 40.7.1 or higher.

pip install --upgrade setuptools

Source: https://github.com/grpc/grpc/issues/17829

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clarifai_grpc-12.1.3.tar.gz (293.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clarifai_grpc-12.1.3-py3-none-any.whl (308.8 kB view details)

Uploaded Python 3

File details

Details for the file clarifai_grpc-12.1.3.tar.gz.

File metadata

  • Download URL: clarifai_grpc-12.1.3.tar.gz
  • Upload date:
  • Size: 293.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for clarifai_grpc-12.1.3.tar.gz
Algorithm Hash digest
SHA256 714203e52148e757073d454eb3b7a8ad17d6d9cc2b618bb6367655bdf7340678
MD5 2154617bd1ea6006e16e88819c6da9a9
BLAKE2b-256 80501c06674abee5b358b28bc8559ad01b2360354957cd9e3bd0a022c80b6018

See more details on using hashes here.

File details

Details for the file clarifai_grpc-12.1.3-py3-none-any.whl.

File metadata

  • Download URL: clarifai_grpc-12.1.3-py3-none-any.whl
  • Upload date:
  • Size: 308.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for clarifai_grpc-12.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d7d1b4190b9cb269946455f8e66883a519256a25f784159bf67cebca8e9c7420
MD5 65038d6ee6953d9d835ddc984626863e
BLAKE2b-256 6751a4831de51bb0b59e8fa6bd6908860e4665f1212f5f4c8a0232593b39070e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page