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-11.6.2.tar.gz (277.9 kB view details)

Uploaded Source

Built Distribution

clarifai_grpc-11.6.2-py3-none-any.whl (293.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clarifai_grpc-11.6.2.tar.gz
  • Upload date:
  • Size: 277.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for clarifai_grpc-11.6.2.tar.gz
Algorithm Hash digest
SHA256 29aea7681d0656b38ab282fd9ae472dbd7780069fdbf93024cc6d5d9d0359af6
MD5 abee5e03b230ff52b256816572957f94
BLAKE2b-256 152384c49a1777558088a4032eeaf31bb53529a275efec8d51aa44ad0da9a14f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clarifai_grpc-11.6.2-py3-none-any.whl
  • Upload date:
  • Size: 293.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for clarifai_grpc-11.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bb8d72e46cf64b84440518c792e1498f684ab85f01e8c5696c59156969a06a92
MD5 af56170403c23a5e05a523f0d640ad55
BLAKE2b-256 1e656a0d03f109d8b85ef5c057b006184b3f7885ea2329d3d9f1ad59962911da

See more details on using hashes here.

Supported by

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