Skip to content

feat: add usage_metadata (including traffic_type) and truncated to EmbedContentResponse for Gemini Enterprise API #3306

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

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add usage_metadata (including traffic_type) and truncated to EmbedContentResponse for Gemini Enterprise API #3306

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
95 changes: 95 additions & 0 deletions google/genai/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,9 @@ def _EmbedContentResponse_from_mldev(
if getv(from_object, ['metadata']) is not None:
setv(to_object, ['metadata'], getv(from_object, ['metadata']))

if getv(from_object, ['usageMetadata']) is not None:
setv(to_object, ['usage_metadata'], getv(from_object, ['usageMetadata']))

return to_object


Expand Down Expand Up @@ -1044,6 +1047,18 @@ def _EmbedContentResponse_from_vertex(
if getv(from_object, ['metadata']) is not None:
setv(to_object, ['metadata'], getv(from_object, ['metadata']))

if getv(from_object, ['truncated']) is not None:
setv(to_object, ['truncated'], getv(from_object, ['truncated']))

if getv(from_object, ['usageMetadata']) is not None:
setv(
to_object,
['usage_metadata'],
_UsageMetadata_from_vertex(
getv(from_object, ['usageMetadata']), to_object, root_object
),
)

if getv(root_object, ['embedding_api_type']) == 'EMBED_CONTENT':
embedding = getv(from_object, ['embedding'])
usage_metadata = getv(from_object, ['usageMetadata'])
Expand Down Expand Up @@ -4180,6 +4195,86 @@ def _UpscaleImageResponse_from_vertex(
return to_object


def _UsageMetadata_from_vertex(
from_object: Union[dict[str, Any], object],
parent_object: Optional[dict[str, Any]] = None,
root_object: Optional[Union[dict[str, Any], object]] = None,
) -> dict[str, Any]:
to_object: dict[str, Any] = {}
if getv(from_object, ['promptTokenCount']) is not None:
setv(
to_object,
['prompt_token_count'],
getv(from_object, ['promptTokenCount']),
)

if getv(from_object, ['cachedContentTokenCount']) is not None:
setv(
to_object,
['cached_content_token_count'],
getv(from_object, ['cachedContentTokenCount']),
)

if getv(from_object, ['candidatesTokenCount']) is not None:
setv(
to_object,
['response_token_count'],
getv(from_object, ['candidatesTokenCount']),
)

if getv(from_object, ['toolUsePromptTokenCount']) is not None:
setv(
to_object,
['tool_use_prompt_token_count'],
getv(from_object, ['toolUsePromptTokenCount']),
)

if getv(from_object, ['thoughtsTokenCount']) is not None:
setv(
to_object,
['thoughts_token_count'],
getv(from_object, ['thoughtsTokenCount']),
)

if getv(from_object, ['totalTokenCount']) is not None:
setv(
to_object, ['total_token_count'], getv(from_object, ['totalTokenCount'])
)

if getv(from_object, ['promptTokensDetails']) is not None:
setv(
to_object,
['prompt_tokens_details'],
[item for item in getv(from_object, ['promptTokensDetails'])],
)

if getv(from_object, ['cacheTokensDetails']) is not None:
setv(
to_object,
['cache_tokens_details'],
[item for item in getv(from_object, ['cacheTokensDetails'])],
)

if getv(from_object, ['candidatesTokensDetails']) is not None:
setv(
to_object,
['response_tokens_details'],
[item for item in getv(from_object, ['candidatesTokensDetails'])],
)

if getv(from_object, ['toolUsePromptTokensDetails']) is not None:
setv(
to_object,
['tool_use_prompt_tokens_details'],
[item for item in getv(from_object, ['toolUsePromptTokensDetails'])],
)

if getv(from_object, ['trafficType']) is not None:
setv(to_object, ['traffic_type'], getv(from_object, ['trafficType']))

return to_object


def _VideoGenerationMask_to_vertex(
from_object: Union[dict[str, Any], object],
parent_object: Optional[dict[str, Any]] = None,
Expand Down
18 changes: 10 additions & 8 deletions google/genai/tests/models/test_embed_content.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_vertex_new_api_text_only_with_config',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=t.t_contents('What is your name?'),
config={
'output_dimensionality': 10,
Expand All @@ -96,7 +96,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_new_api_text_only',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=t.t_contents('What is your name?'),
config={
'output_dimensionality': 100,
Expand All @@ -120,7 +120,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_new_api_gcs_image_and_config',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=[
types.Content(
parts=[
Expand All @@ -147,7 +147,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_new_api_inline_pdf',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=[
types.Content(
parts=[
Expand Down Expand Up @@ -178,7 +178,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_vertex_inline_pdf_document_ocr',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=[
types.Content(
parts=[
Expand All @@ -199,7 +199,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:
pytest_helper.TestTableItem(
name='test_vertex_inline_video_audio_track_extraction',
parameters=types.EmbedContentParameters(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=[
types.Content(
parts=[
Expand Down Expand Up @@ -229,7 +229,7 @@ def _get_bytes_from_file(relative_path: str) -> bytes:

def test_gemini_embedding_2_content_combination(client):
response = client.models.embed_content(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=[
'The jetpack is cool',
types.Part.from_bytes(
Expand All @@ -253,6 +253,8 @@ def test_gemini_embedding_2_content_combination(client):
assert statistics.token_count is not None
assert statistics.tokens_details is not None
assert len(statistics.tokens_details) > 0
assert response.usage_metadata is not None
assert response.usage_metadata.traffic_type is not None


@pytest.mark.asyncio
Expand All @@ -268,7 +270,7 @@ async def test_async(client):
@pytest.mark.asyncio
async def test_async_new_api(client):
response = await client.aio.models.embed_content(
model='gemini-embedding-2-preview',
model='gemini-embedding-2',
contents=t.t_contents('What is your name?'),
config={'output_dimensionality': 10},
)
Expand Down
Loading
Loading