Skip to content

Commit 6cbe865

Browse files
authored
fix(ai): deprecate topK and temperature for hybrid (#9816)
1 parent 9620f9a commit 6cbe865

4 files changed

Lines changed: 22 additions & 2 deletions

File tree

.changeset/gold-chefs-jam.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@firebase/ai': minor
3+
'firebase': minor
4+
---
5+
6+
Deprecate `topK` and `temperature` properties for hybrid inference mode.

common/api-review/ai.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -896,9 +896,9 @@ export type Language = (typeof Language)[keyof typeof Language];
896896
export interface LanguageModelCreateCoreOptions {
897897
// (undocumented)
898898
expectedInputs?: LanguageModelExpected[];
899-
// (undocumented)
899+
// @deprecated (undocumented)
900900
temperature?: number;
901-
// (undocumented)
901+
// @deprecated (undocumented)
902902
topK?: number;
903903
}
904904

docs-devsite/ai.languagemodelcreatecoreoptions.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ expectedInputs?: LanguageModelExpected[];
4545
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
4646
>
4747

48+
> Warning: This API is now obsolete.
49+
>
50+
>
51+
4852
<b>Signature:</b>
4953

5054
```typescript
@@ -56,6 +60,10 @@ temperature?: number;
5660
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
5761
>
5862

63+
> Warning: This API is now obsolete.
64+
>
65+
>
66+
5967
<b>Signature:</b>
6068

6169
```typescript

packages/ai/src/types/language-model.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,13 @@ export enum Availability {
5454
* @beta
5555
*/
5656
export interface LanguageModelCreateCoreOptions {
57+
/**
58+
* @deprecated
59+
*/
5760
topK?: number;
61+
/**
62+
* @deprecated
63+
*/
5864
temperature?: number;
5965
expectedInputs?: LanguageModelExpected[];
6066
}

0 commit comments

Comments
 (0)