Skip to content

Fix typos #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2025
Merged

Fix typos #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following naming conventions must be followed for consistency and autoloadin
- Traits are suffixed with `Trait`.
- Enums are suffixed with `Enum`.
- File names are the same as the class, trait, and interface name for PSR-4 autoloading.
- Classes, interfaces, and traits, and namespaces are not prefixed with `Ai`, exluding the root namespace.
- Classes, interfaces, and traits, and namespaces are not prefixed with `Ai`, excluding the root namespace.

## Documentation standards

Expand Down
8 changes: 4 additions & 4 deletions docs/ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ $texts = AiClient::generateTextResult(

##### Fluent API
```php
$imageFile = AiClient::prompt('Generate an illustration of the PHP elephant in the Carribean sea.')
$imageFile = AiClient::prompt('Generate an illustration of the PHP elephant in the Caribbean sea.')
->usingProvider('openai')
->generateImage();
```
Expand All @@ -85,7 +85,7 @@ $modelsMetadata = AiClient::defaultRegistry()->findProviderModelsMetadataForSupp
new ModelRequirements([CapabilityEnum::IMAGE_GENERATION])
);
$imageFile = AiClient::generateImageResult(
'Generate an illustration of the PHP elephant in the Carribean sea.',
'Generate an illustration of the PHP elephant in the Caribbean sea.',
AiClient::defaultRegistry()->getProviderModel(
'openai',
$modelsMetadata[0]->getId()
Expand All @@ -97,7 +97,7 @@ $imageFile = AiClient::generateImageResult(

##### Fluent API
```php
$imageFile = AiClient::prompt('Generate an illustration of the PHP elephant in the Carribean sea.')
$imageFile = AiClient::prompt('Generate an illustration of the PHP elephant in the Caribbean sea.')
->generateImage();
```

Expand All @@ -107,7 +107,7 @@ $providerModelsMetadata = AiClient::defaultRegistry()->findModelsMetadataForSupp
new ModelRequirements([CapabilityEnum::IMAGE_GENERATION])
);
$imageFile = AiClient::generateImageResult(
'Generate an illustration of the PHP elephant in the Carribean sea.',
'Generate an illustration of the PHP elephant in the Caribbean sea.',
AiClient::defaultRegistry()->getProviderModel(
$providerModelsMetadata[0]->getProvider()->getId(),
$providerModelsMetadata[0]->getModels()[0]->getId()
Expand Down
2 changes: 1 addition & 1 deletion docs/REQUIREMENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ There are two primary developer audiences this client is intended for. This is i

### Extenders

Extenders are the folks that will be adding providers, models, and otherwise extending the functionality of the client itself. These are highly technical people who likely have a stronger understanding of how models and model APIs work. Given their capabilities, these APIs will be more technical and formal in nature, using things such as interfaces, traits, and so forth, relying on a knowledge of inheritence and composition.
Extenders are the folks that will be adding providers, models, and otherwise extending the functionality of the client itself. These are highly technical people who likely have a stronger understanding of how models and model APIs work. Given their capabilities, these APIs will be more technical and formal in nature, using things such as interfaces, traits, and so forth, relying on a knowledge of inheritance and composition.

### Implementers

Expand Down