Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rlazo committed Feb 19, 2025
1 parent db47a2f commit 2efd3fa
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs-devsite/_toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,8 @@ toc:
path: /docs/reference/js/vertexai.inlinedatapart.md
- title: IntegerSchema
path: /docs/reference/js/vertexai.integerschema.md
- title: ModalityTokenCount
path: /docs/reference/js/vertexai.modalitytokencount.md
- title: ModelParams
path: /docs/reference/js/vertexai.modelparams.md
- title: NumberSchema
Expand Down
11 changes: 11 additions & 0 deletions docs-devsite/vertexai.counttokensresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,20 @@ export interface CountTokensResponse

| Property | Type | Description |
| --- | --- | --- |
| [promptTokensDetails](./vertexai.counttokensresponse.md#counttokensresponseprompttokensdetails) | [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface)<!-- -->\[\] | The breakdown, by modality, of how many tokens are consumed by the prompt. |
| [totalBillableCharacters](./vertexai.counttokensresponse.md#counttokensresponsetotalbillablecharacters) | number | The total number of billable characters counted across all instances from the request. |
| [totalTokens](./vertexai.counttokensresponse.md#counttokensresponsetotaltokens) | number | The total number of tokens counted across all instances from the request. |

## CountTokensResponse.promptTokensDetails

The breakdown, by modality, of how many tokens are consumed by the prompt.

<b>Signature:</b>

```typescript
promptTokensDetails?: ModalityTokenCount[];
```

## CountTokensResponse.totalBillableCharacters

The total number of billable characters counted across all instances from the request.
Expand Down
23 changes: 23 additions & 0 deletions docs-devsite/vertexai.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ The Vertex AI in Firebase Web SDK.
| [HarmCategory](./vertexai.md#harmcategory) | Harm categories that would cause prompts or candidates to be blocked. |
| [HarmProbability](./vertexai.md#harmprobability) | Probability that a prompt or candidate matches a harm category. |
| [HarmSeverity](./vertexai.md#harmseverity) | Harm severity levels. |
| [Modality](./vertexai.md#modality) | Content part modality. |
| [SchemaType](./vertexai.md#schematype) | Contains the list of OpenAPI data types as defined by the [OpenAPI specification](https://swagger.io/docs/specification/data-models/data-types/) |
| [VertexAIErrorCode](./vertexai.md#vertexaierrorcode) | Standardized error codes that <code>[VertexAIError](./vertexai.vertexaierror.md#vertexaierror_class)</code> can have. |

Expand Down Expand Up @@ -84,6 +85,7 @@ The Vertex AI in Firebase Web SDK.
| [GroundingAttribution](./vertexai.groundingattribution.md#groundingattribution_interface) | |
| [GroundingMetadata](./vertexai.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
| [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
| [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface) | Represents token counting info for a single modality. |
| [ModelParams](./vertexai.modelparams.md#modelparams_interface) | Params passed to <code>[getGenerativeModel()](./vertexai.md#getgenerativemodel_e3037c9)</code>. |
| [ObjectSchemaInterface](./vertexai.objectschemainterface.md#objectschemainterface_interface) | Interface for <code>[ObjectSchema](./vertexai.objectschema.md#objectschema_class)</code> class. |
| [PromptFeedback](./vertexai.promptfeedback.md#promptfeedback_interface) | If the prompt was blocked, this will be populated with <code>blockReason</code> and the relevant <code>safetyRatings</code>. |
Expand Down Expand Up @@ -363,6 +365,27 @@ export declare enum HarmSeverity
| HARM\_SEVERITY\_MEDIUM | <code>&quot;HARM_SEVERITY_MEDIUM&quot;</code> | |
| HARM\_SEVERITY\_NEGLIGIBLE | <code>&quot;HARM_SEVERITY_NEGLIGIBLE&quot;</code> | |

## Modality

Content part modality.

<b>Signature:</b>

```typescript
export declare enum Modality
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| AUDIO | <code>&quot;AUDIO&quot;</code> | Audio. |
| DOCUMENT | <code>&quot;DOCUMENT&quot;</code> | Document, e.g. PDF. |
| IMAGE | <code>&quot;IMAGE&quot;</code> | Image. |
| MODALITY\_UNSPECIFIED | <code>&quot;MODALITY_UNSPECIFIED&quot;</code> | Unspecified modality. |
| TEXT | <code>&quot;TEXT&quot;</code> | Plain text. |
| VIDEO | <code>&quot;VIDEO&quot;</code> | Video. |

## SchemaType

Contains the list of OpenAPI data types as defined by the [OpenAPI specification](https://swagger.io/docs/specification/data-models/data-types/)
Expand Down
18 changes: 18 additions & 0 deletions docs-devsite/vertexai.usagemetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ export interface UsageMetadata
| Property | Type | Description |
| --- | --- | --- |
| [candidatesTokenCount](./vertexai.usagemetadata.md#usagemetadatacandidatestokencount) | number | |
| [candidatesTokensDetails](./vertexai.usagemetadata.md#usagemetadatacandidatestokensdetails) | [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface)<!-- -->\[\] | |
| [promptTokenCount](./vertexai.usagemetadata.md#usagemetadataprompttokencount) | number | |
| [promptTokensDetails](./vertexai.usagemetadata.md#usagemetadataprompttokensdetails) | [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface)<!-- -->\[\] | |
| [totalTokenCount](./vertexai.usagemetadata.md#usagemetadatatotaltokencount) | number | |

## UsageMetadata.candidatesTokenCount
Expand All @@ -34,6 +36,14 @@ export interface UsageMetadata
candidatesTokenCount: number;
```

## UsageMetadata.candidatesTokensDetails

<b>Signature:</b>

```typescript
candidatesTokensDetails?: ModalityTokenCount[];
```

## UsageMetadata.promptTokenCount

<b>Signature:</b>
Expand All @@ -42,6 +52,14 @@ candidatesTokenCount: number;
promptTokenCount: number;
```

## UsageMetadata.promptTokensDetails

<b>Signature:</b>

```typescript
promptTokensDetails?: ModalityTokenCount[];
```

## UsageMetadata.totalTokenCount

<b>Signature:</b>
Expand Down
6 changes: 3 additions & 3 deletions packages/rules-unit-testing/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../config/api-extractor.json",
// Point it to your entry point d.ts file.
"mainEntryPointFilePath": "<projectFolder>/dist/rules-unit-testing/index.d.ts"
}
// Point it to your entry point d.ts file.
"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts"
}

0 comments on commit 2efd3fa

Please sign in to comment.