API

Flow Intelligence Prediction, Vector Upsert ve Message API'yi nasıl kullanacağınızı öğrenin

1. Tahmin API'si

YAYINLA /api/v1/prediction/{your-chatflowid}

İstek Gövdesi

Anahtar

Açıklama

Tür

Gerekli

soru

Kullanıcının sorusu

dizgi

Evet

overrideConfig

Mevcut akış yapılandırmasını geçersiz kıl

nesne

Hayır

tarih

Konuşmanın başında geçmiş iletilerinin başına ekleme

dizi

Hayır

Chatflow'u API olarak kullanabilir ve ön uç uygulamalarına bağlanabilirsiniz.

Yapılandırmayı Geçersiz Kıl

Ayrıca, overrideConfig özelliğiyle giriş yapılandırmasını geçersiz kılma esnekliğine de sahipsiniz.

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "sessionId": "123",
        "returnSourceDocuments": true
    }
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "sessionId": "123",
        "returnSourceDocuments": true
    }
}).then((response) => {
    console.log(response);
});

Tarih

LLM'ye biraz bağlam kazandırmak için geçmiş iletilerinin başına ekleyebilirsiniz. Örneğin, LLM'nin kullanıcının adını hatırlamasını istiyorsanız:

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Hey, how are you?",
    "history": [
        {
            "role": "apiMessage",
            "content": "Hello how can I help?"
        },
        {
            "role": "userMessage",
            "content": "Hi my name is Brian"
        },
        {
            "role": "apiMessage",
            "content": "Hi Brian, how can I help?"
        },
    ]
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "question": "Hey, how are you?",
    "history": [
        {
            "role": "apiMessage",
            "content": "Hello how can I help?"
        },
        {
            "role": "userMessage",
            "content": "Hi my name is Brian"
        },
        {
            "role": "apiMessage",
            "content": "Hi Brian, how can I help?"
        },
    ]
}).then((response) => {
    console.log(response);
});

Belleği Kalıcı Hale Getirir

Sohbet akışı Bellek düğümleri içeriyorsa, konuşmanın durumunu kalıcı hale getirmek için bir iletebilirsiniz, böylece sonraki her API çağrısı önceki konuşma hakkında bağlama sahip olur. Aksi takdirde, her seferinde yeni bir oturum oluşturulur .sessionId

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "sessionId": "123"
    } 
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "sessionId": "123"
    }
}).then((response) => {
    console.log(response);
});

Değişken

Akıştaki düğümler tarafından kullanılmak üzere API'de değişken geçirebilirsiniz. Daha fazlasını gör: Variables

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "vars": {
            "foo": "bar"
        }
    }
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "question": "Hey, how are you?",
    "overrideConfig": {
        "vars": {
            "foo": "bar"
        }
    }
}).then((response) => {
    console.log(response);
});

Resim Yüklemeleri

Resim Yüklemeye İzin Ver etkinleştirildiğinde, resimler sohbet arayüzünden yüklenebilir.

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "question": "Can you describe the image?",
    "uploads": [
        {
            "data": 'data:image/png;base64,iVBORw0KGgdM2uN0', # base64 string or url
            "type": 'file', # file | url
            "name": 'flow.png',
            "mime": 'image/png'
        }
    ]
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "question": "Can you describe the image?",
    "uploads": [
        {
            "data": 'data:image/png;base64,iVBORw0KGgdM2uN0', //base64 string or url
            "type": 'file', //file | url
            "name": 'Flowise.png',
            "mime": 'image/png'
        }
    ]
}).then((response) => {
    console.log(response);
});

Konuşmayı Metne Dönüştürme

Konuşmayı Metne Dönüştürme etkinleştirildiğinde, kullanıcılar doğrudan mikrofona konuşabilir ve konuşma metne dönüştürülür.

import requests
API_URL = "http://localhost:3000/api/v1/prediction/&#x3C;chatlfowid>"

def query(payload):
    response = requests.post(API_URL, json=payload)
    return response.json()
    
output = query({
    "uploads": [
        {
            "data": 'data:audio/webm;codecs=opus;base64,GkXf', #base64 string
            "type": 'audio',
            "name": 'audio.wav',
            "mime": 'audio/webm'
        }
    ]
})

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/prediction/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "uploads": [
        {
            "data": 'data:audio/webm;codecs=opus;base64,GkXf', //base64 string
            "type": 'audio',
            "name": 'audio.wav',
            "mime": 'audio/webm'
        }
    ]
}).then((response) => {
    console.log(response);
});

Kimlik doğrulama

Kullanıcı arayüzünden tahmin API'sine bir API anahtarı atayabilirsiniz. Daha fazla ayrıntı için Chatflow Level'a bakın.

Yetkilendirme üst bilgisi, bir HTTP çağrısı sırasında belirtilen doğru API anahtarıyla sağlanmalıdır.

"Authorization": "Bearer <your-api-key>"

2. Vektör Upsert API'sı

YAYINLA /api/v1/vector/upsert/{your-chatflowid}

İstek Gövdesi

Anahtar

Açıklama

Tür

Gerekli

overrideConfig

Mevcut akış yapılandırmasını geçersiz kıl

nesne

Hayır

stopNodeId

Vektör deposunun düğüm kimliği. Bir akışta birden çok vektör deponuz olduğunda, bunların tümünü yükseltmek istemeyebilirsiniz. Belirtmek, yalnızca belirli bir vektör deposu düğümünün onaylanmasını sağlar.stopNodeId

dizi

Hayır

Yüklemeli Belge Yükleyiciler

Flowise'deki bazı belge yükleyiciler, kullanıcının dosya yüklemesine izin verir:

Akış, Dosya Karşıya Yükleme işlevine sahip Belge Yükleyiciler içeriyorsa API biraz farklı görünür. Body'yi JSON olarak geçirmek yerine form-data kullanılıyor. Bu, API'ye herhangi bir dosya yüklemenize olanak tanır.

Dosya türünün, belge yükleyiciden beklenen dosya türüyle uyumlu olduğundan emin olmak kullanıcının sorumluluğundadır. Örneğin, bir Metin Dosyası Yükleyici kullanılıyorsa, yalnızca uzantılı dosyayı yüklemelisiniz..txt

import requests

API_URL = "http://localhost:3000/api/v1/vector/upsert/<chatlfowid>"

# use form data to upload files
form_data = {
    "files": ('state_of_the_union.txt', open('state_of_the_union.txt', 'rb'))
}

body_data = {
    "returnSourceDocuments": True
}

def query(form_data):
    response = requests.post(API_URL, files=form_data, data=body_data)
    print(response)
    return response.json()

output = query(form_data)
print(output)

// use FormData to upload files
let formData = new FormData();
formData.append("files", input.files[0]);
formData.append("returnSourceDocuments", true);

async function query(formData) {
    const response = await fetch(
        "http://localhost:3000/api/v1/vector/upsert/<chatlfowid>",
        {
            method: "POST",
            body: formData
        }
    );
    const result = await response.json();
    return result;
}

query(formData).then((response) => {
    console.log(response);
});

Yüklemeden Belge Yükleyiciler

Dosya Yükleme işlevine sahip olmayan diğer Belge Yükleyici düğümleri için API gövdesi, Tahmin API'sine benzer JSON biçimindedir.

import requests

API_URL = "http://localhost:3000/api/v1/vector/upsert/<chatlfowid>"

def query(form_data):
    response = requests.post(API_URL, json=payload)
    print(response)
    return response.json()

output = query({
    "overrideConfig": { # optional
        "returnSourceDocuments": true
    }
})
print(output)// Some code

async function query(data) {
    const response = await fetch(
        "http://localhost:3000/api/v1/vector/upsert/<chatlfowid>",
        {
            method: "POST",
            headers: {
                "Content-Type": "application/json"
            },
            body: JSON.stringify(data)
        }
    );
    const result = await response.json();
    return result;
}

query({
    "overrideConfig": { // optional
        "returnSourceDocuments": true
    }
}).then((response) => {
    console.log(response);
});

Kimlik doğrulama

Kullanıcı arayüzünden tahmin API'sine bir API anahtarı atayabilirsiniz. Daha fazla ayrıntı için Chatflow Level'a bakın.

Yetkilendirme üst bilgisi, bir HTTP çağrısı sırasında belirtilen doğru API anahtarıyla sağlanmalıdır.

Kopya etmek

"Authorization": "Bearer <your-api-key>"

3. Mesaj API'sı

AL /api/v1/chatmessage/{your-chatflowid}
SİLMEK /api/v1/chatmessage/{your-chatflowid}

Sorgu Parametreleri

Param

Tür

Değer

sessionId (Oturum Kimliği)

dizgi

tür

numaralandırma

ASC veya DESC

başlangıç tarihi

dizgi

bitiş tarihi

dizgi

Kimlik doğrulama

Mesaj API'si yalnızca Flowise yönetici kullanıcısıyla sınırlıdır. Flowise örneği ve ile yapılandırılmışsa üst bilgilerde temel kimlik doğrulaması sağlanmalıdır. Daha fazla ayrıntı için Uygulama Düzeyi'ne bakın. FLOWISE_USERNAMEFLOWISE_PASSWORD

"Authorization": "Basic " + Buffer.from(username + ":" + password).toString('base64')

Video Eğitimler

Bu video eğitimleri, Flow Intelligence API'yi uygulamak için ana kullanım örneklerini kapsar.

YOUTUBE VİDEOLARI!!

PreviousSequential Agents NextAnalitik

Last updated 1 year ago