Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"test:lint": "@php vendor/bin/pint --config https://raw.githubusercontent.com/DIJ-digital/pint-config/main/pint.json",
"test:unit": "pest",
"test:types": "phpstan",
"test:refactor": "rector --dry-run",
"test:refactor": "rector",
"test": [
"@test:lint",
"@test:type-coverage",
Expand Down
16 changes: 8 additions & 8 deletions src/Contracts/TransporterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,34 @@
interface TransporterInterface
{
/**
* @param array<string, mixed> $options
* @param array<string, mixed> $options
*/
public function request(string $method, string $uri, array $options = []): ResponseInterface;

/**
* @param array<string, mixed> $options
* @param array<string, mixed> $options
*/
public function get(string $uri, array $options = []): ResponseInterface;

/**
* @param array<string, mixed> $options
* @param array<string, mixed> $options
*/
public function post(string $uri, array $options = []): ResponseInterface;

/**
* @param array<string, mixed> $data
* @param array<string, mixed> $options
* @param array<string, mixed> $data
* @param array<string, mixed> $options
*/
public function postJson(string $uri, array $data = [], array $options = []): ResponseInterface;

/**
* @param array<string, mixed> $options
* @param array<string, mixed> $options
*/
public function delete(string $uri, array $options = []): ResponseInterface;

/**
* @param array<string, mixed> $data
* @param array<string, mixed> $options
* @param array<string, mixed> $data
* @param array<string, mixed> $options
*/
public function patchJson(string $uri, array $data = [], array $options = []): ResponseInterface;
}
100 changes: 100 additions & 0 deletions src/DatasetItem.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP;

use DIJ\Langfuse\PHP\Contracts\TransporterInterface;
use DIJ\Langfuse\PHP\Enums\DatasetStatus;
use DIJ\Langfuse\PHP\Responses\DatasetItemListResponse;
use DIJ\Langfuse\PHP\Responses\DatasetItemResponse;
use JsonException;

class DatasetItem
{
public function __construct(private readonly TransporterInterface $transporter) {}

/**
* @param array<string, mixed>|null $metadata
*
* @throws JsonException
*/
public function create(
string $datasetName,
mixed $input = null,
mixed $expectedOutput = null,
?array $metadata = null,
?string $sourceTraceId = null,
?string $sourceObservationId = null,
?string $id = null,
?DatasetStatus $status = null,
): DatasetItemResponse {
$response = $this->transporter->postJson(
'/api/public/dataset-items',
array_filter([
'datasetName' => $datasetName,
'input' => $input,
'expectedOutput' => $expectedOutput,
'metadata' => $metadata,
'sourceTraceId' => $sourceTraceId,
'sourceObservationId' => $sourceObservationId,
'id' => $id,
'status' => $status?->value,
], fn ($value) => $value !== null)
);

/** @var array{id: string, status: string, datasetId: string, datasetName: string, createdAt: string, updatedAt: string, input?: mixed, expectedOutput?: mixed, metadata?: array<string, mixed>|null, sourceTraceId?: string|null, sourceObservationId?: string|null} $data */
$data = json_decode($response->getBody()->getContents(), true, flags: JSON_THROW_ON_ERROR);

return DatasetItemResponse::fromArray($data);
}

/**
* @throws JsonException
*/
public function get(string $id): DatasetItemResponse
{
$response = $this->transporter->get(
sprintf('/api/public/dataset-items/%s', urlencode($id))
);

/** @var array{id: string, status: string, datasetId: string, datasetName: string, createdAt: string, updatedAt: string, input?: mixed, expectedOutput?: mixed, metadata?: array<string, mixed>|null, sourceTraceId?: string|null, sourceObservationId?: string|null} $data */
$data = json_decode($response->getBody()->getContents(), true, flags: JSON_THROW_ON_ERROR);

return DatasetItemResponse::fromArray($data);
}

/**
* @throws JsonException
*/
public function list(
?string $datasetName = null,
?string $sourceTraceId = null,
?string $sourceObservationId = null,
?int $page = null,
?int $limit = null,
): DatasetItemListResponse {
$response = $this->transporter->get(
'/api/public/dataset-items',
['query' => array_filter([
'datasetName' => $datasetName,
'sourceTraceId' => $sourceTraceId,
'sourceObservationId' => $sourceObservationId,
'page' => $page,
'limit' => $limit,
], fn ($value) => $value !== null)]
);

/** @var array{data: array<int, array{id: string, status: string, datasetId: string, datasetName: string, createdAt: string, updatedAt: string, input?: mixed, expectedOutput?: mixed, metadata?: array<string, mixed>|null, sourceTraceId?: string|null, sourceObservationId?: string|null}>, meta: array{page: int, limit: int, totalPages: int, totalItems: int}} $data */
$data = json_decode($response->getBody()->getContents(), true, flags: JSON_THROW_ON_ERROR);

return DatasetItemListResponse::fromArray($data);
}

public function delete(string $id): void
{
$this->transporter->delete(
sprintf('/api/public/dataset-items/%s', urlencode($id))
);
}
}
11 changes: 11 additions & 0 deletions src/Enums/DatasetStatus.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP\Enums;

enum DatasetStatus: string
{
case ACTIVE = 'ACTIVE';
case ARCHIVED = 'ARCHIVED';
}
10 changes: 8 additions & 2 deletions src/Langfuse.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ public function __construct(
private readonly TransporterInterface $transporter,
private readonly string $environment = 'default',
private readonly string $label = 'latest',
) {
}
) {}

public function prompt(): Prompt
{
Expand All @@ -37,4 +36,11 @@ public function score(): Score
transporter: $this->transporter,
);
}

public function datasetItem(): DatasetItem
{
return new DatasetItem(
transporter: $this->transporter,
);
}
}
35 changes: 35 additions & 0 deletions src/Responses/DatasetItemListResponse.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP\Responses;

use DIJ\Langfuse\PHP\ValueObjects\MetaData;

readonly class DatasetItemListResponse
{
/**
* @param array<int, DatasetItemResponse> $data
*/
public function __construct(
public array $data,
public MetaData $meta,
) {}

/**
* @param array{
* data: array<int, array{id: string, status: string, datasetId: string, datasetName: string, createdAt: string, updatedAt: string, input?: mixed, expectedOutput?: mixed, metadata?: array<string, mixed>|null, sourceTraceId?: string|null, sourceObservationId?: string|null}>,
* meta: array{page: int, limit: int, totalPages: int, totalItems: int}
* } $data
*/
public static function fromArray(array $data): self
{
return new self(
data: array_map(
fn (array $item): DatasetItemResponse => DatasetItemResponse::fromArray($item),
$data['data']
),
meta: MetaData::fromArray($data['meta']),
);
}
}
59 changes: 59 additions & 0 deletions src/Responses/DatasetItemResponse.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP\Responses;

use DIJ\Langfuse\PHP\Enums\DatasetStatus;

readonly class DatasetItemResponse
{
/**
* @param array<string, mixed>|null $metadata
*/
public function __construct(
public string $id,
public DatasetStatus $status,
public string $datasetId,
public string $datasetName,
public string $createdAt,
public string $updatedAt,
public mixed $input = null,
public mixed $expectedOutput = null,
public ?array $metadata = null,
public ?string $sourceTraceId = null,
public ?string $sourceObservationId = null,
) {}

/**
* @param array{
* id: string,
* status: string,
* datasetId: string,
* datasetName: string,
* createdAt: string,
* updatedAt: string,
* input?: mixed,
* expectedOutput?: mixed,
* metadata?: array<string, mixed>|null,
* sourceTraceId?: string|null,
* sourceObservationId?: string|null
* } $data
*/
public static function fromArray(array $data): self
{
return new self(
id: $data['id'],
status: DatasetStatus::from($data['status']),
datasetId: $data['datasetId'],
datasetName: $data['datasetName'],
createdAt: $data['createdAt'],
updatedAt: $data['updatedAt'],
input: $data['input'] ?? null,
expectedOutput: $data['expectedOutput'] ?? null,
metadata: $data['metadata'] ?? null,
sourceTraceId: $data['sourceTraceId'] ?? null,
sourceObservationId: $data['sourceObservationId'] ?? null,
);
}
}
63 changes: 63 additions & 0 deletions src/Testing/Responses/GetDatasetItemListResponse.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP\Testing\Responses;

use GuzzleHttp\Psr7\Response;

class GetDatasetItemListResponse extends Response
{
/**
* @param array<array<string>|string> $headers
* @param array<string, mixed> $data
*/
public function __construct(int $status = 200, array $headers = [], string $version = '1.1', ?string $reason = null, array $data = [])
{
parent::__construct($status, $headers, (string) json_encode($this->payload($data)), $version, $reason);
}

/**
* @param array<string, mixed> $data
* @return array<string, mixed>
*/
public function payload(array $data = []): array
{
return array_merge([
'data' => [
[
'id' => 'item-123',
'status' => 'ACTIVE',
'datasetId' => 'dataset-456',
'datasetName' => 'test-dataset',
'createdAt' => '2025-01-15T10:00:00.000Z',
'updatedAt' => '2025-01-15T10:00:00.000Z',
'input' => ['prompt' => 'What is AI?'],
'expectedOutput' => ['response' => 'AI is artificial intelligence'],
'metadata' => ['key' => 'value'],
'sourceTraceId' => null,
'sourceObservationId' => null,
],
[
'id' => 'item-456',
'status' => 'ACTIVE',
'datasetId' => 'dataset-456',
'datasetName' => 'test-dataset',
'createdAt' => '2025-01-16T10:00:00.000Z',
'updatedAt' => '2025-01-16T10:00:00.000Z',
'input' => ['prompt' => 'What is ML?'],
'expectedOutput' => ['response' => 'ML is machine learning'],
'metadata' => null,
'sourceTraceId' => 'trace-789',
'sourceObservationId' => null,
],
],
'meta' => [
'page' => 1,
'limit' => 50,
'totalPages' => 1,
'totalItems' => 2,
],
], $data);
}
}
40 changes: 40 additions & 0 deletions src/Testing/Responses/GetDatasetItemResponse.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

declare(strict_types=1);

namespace DIJ\Langfuse\PHP\Testing\Responses;

use GuzzleHttp\Psr7\Response;

class GetDatasetItemResponse extends Response
{
/**
* @param array<array<string>|string> $headers
* @param array<string, mixed> $data
*/
public function __construct(int $status = 200, array $headers = [], string $version = '1.1', ?string $reason = null, array $data = [])
{
parent::__construct($status, $headers, (string) json_encode($this->payload($data)), $version, $reason);
}

/**
* @param array<string, mixed> $data
* @return array<string, mixed>
*/
public function payload(array $data = []): array
{
return array_merge([
'id' => 'item-123',
'status' => 'ACTIVE',
'datasetId' => 'dataset-456',
'datasetName' => 'test-dataset',
'createdAt' => '2025-01-15T10:00:00.000Z',
'updatedAt' => '2025-01-15T10:00:00.000Z',
'input' => ['prompt' => 'What is AI?'],
'expectedOutput' => ['response' => 'AI is artificial intelligence'],
'metadata' => ['key' => 'value'],
'sourceTraceId' => null,
'sourceObservationId' => null,
], $data);
}
}
Loading