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.5.1.tar.gz (291.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.5.1-py3-none-any.whl (308.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for clarifai_grpc-12.5.1.tar.gz
Algorithm Hash digest
SHA256 5c0419d717fa0366cbf2687a32c635cb88af39b76dd7d041c18a16fd71b0c99f
MD5 e001ec9505985cfe21f908fe39b9bb7d
BLAKE2b-256 6038f0bfa7b31355ff3814aeab3d4eba0f5a4a6f6df4199a719578a40edbe33c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for clarifai_grpc-12.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 43e8a3ab3e4feeb4698f5e2b3cfacb9ffbcba62f6d4e917dccfae574080e785f
MD5 b2a308efce010de7d1e12e4274a86e2e
BLAKE2b-256 d29e172d1e39f5f1e26ee374e70ae61d9782f3ca1dec69568de3356335b7c925

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