mathsgod/semantic-splitter-php

A PHP library for splitting the paragraphs of a text into sentences based on semantic meaning.

1.1.0 2024-07-17 08:47 UTC

Requires (Dev)

• mathsgod/openai-client: ^1.3

MIT

• Raymond Chong

README

This is a simple tool to split a text into sentences by semantic meaning. Each sentence will be grouped together if they have similar meaning. Each sentence should be separated by a newline character.

Installation

composer require mathsgod/semantic-splitter-php

Usage

$splitter = new TextSplitter\SemanticTextSplitter(new MyEmbeddingRetriever());

$sentences= $splitter->split("I am a sentence. 
I am another sentence.
I am a sentence that is a question?

這是一個中文句子。
這是另一個中文句子。

如果句子意思接近, 這個工具會把他們放在一起。");

print_r($sentences);

/// Output

Array
(
    [0] => I am a sentence.
I am another sentence.
I am a sentence that is a question?
    [1] => 這是一個中文句子。
這是另一個中文句子。
如果句子意思接近, 這個工具會把他們放在一起。
如果句子意思不接近, 這個工具會把他們分開。
作者: 陳大文
)

Embedding retriever

Semantic Text Splitter requires an embedding retriever to work. You can implement your own retriever by implementing the TextSplitter\EmbeddingRetrieverInterface interface.

class MyEmbeddingRetriever implements TextSplitter\EmbeddingRetrieverInterface
{
    public function getEmbedding(string $text): array
    {
        // Implement your own embedding retriever here
        // for example, you can use OpenAI to get the embedding of the text
        return [0.1, 0.2, 0.3];
    }
}