Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key, as follows:
  1. After you sign in to your Unstructured Let’s Go, Pay-As-You-Go, or Business account, click API Keys on the sidebar.
     For a Business account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more.
  2. Click Generate API Key.
  3. Follow the on-screen instructions to finish generating the key.
  4. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the the notebook Dropbox-To-Pinecone Connector API Quickstart for Unstructured, or watch the two 4-minute video tutorials for the Unstructured Python SDK.You can also create source connectors with the Unstructured user interface (UI). Learn how.If you need help, email Unstructured Support at support@unstructured.io.You are now ready to start creating a source connector! Keep reading to learn how.
Ingest your files into Unstructured from Kafka.

​
Requirements

You will need:

​
Examples

To create a Kafka source connector, see the following examples. For more information on working with source connectors using the Unstructured API, see Source endpoints. 
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="kafka-cloud",
                config={
                    "bootstrap_servers": "<bootstrap-server>",
                    "port": <port>,
                    "group_id": "<group-id>",
                    "kafka_api_key": "<kafka-api-key>",
                    "secret": "<secret>",
                    "topic": "<topic>",
                    "num_message_to_consume": <num-message-to-consume>
                }
            )
        )
    )

    print(response.source_connector_information)

​
Configuration settings

Replace the preceding placeholders as follows:
​
name
string
required
A unique name for this connector.
​
bootstrap_server
string
The hostname of the bootstrap Kafka cluster to connect to.
​
port
integer
default:"9092"
The port number of the bootstrap Kafka cluster to connect to.
​
group_id
string
default:"default_group_id"
The ID of the consumer group. A consumer group is a way to allow a pool of consumers to divide the consumption of data over topics and partitions.
​
kafka_api_key
string
For authentication, the API key for access to the cluster.
​
secret
string
For authentication, the secret for access to the cluster.
​
topic
string
The name of the topic to read messages from or write messages to on the cluster.
​
batch_size
integer
default:"100"
Destination connector only. The maximum number of messages to send in a single batch.
​
num_messages_to_consume
integer
default:"100"
Source connector only. The maximum number of messages that the consumer will try to consume.

​
Learn more