Corpora

Metoda: corpora.create

Tworzy pusty element Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/corpora

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
name string

Niezmienne. Identyfikator. Corpus Nazwa zasobu. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli nazwa jest pusta podczas tworzenia, unikalna nazwa zostanie utworzona na podstawie displayName wraz z 12-znakowym losowym sufiksem. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie. Czytelna nazwa wyświetlana dla Corpus. Wyświetlana nazwa nie może mieć więcej niż 512 znaków, w tym spacji. Przykład: „Dokumenty w wyszukiwarce semantycznej”

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Corpus.

Metoda: corpora.query

Przeprowadza wyszukiwanie semantyczne w Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parametry ścieżki

name string

Wymagany. Nazwa Corpus, której ma dotyczyć zapytanie. Przykład: corpora/my-corpus-123 przyjmuje postać corpora/{corpora}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
query string

Wymagany. Ciąg zapytania do wyszukiwania semantycznego.

metadataFilters[] object (MetadataFilter)

Opcjonalnie. Filtruj metadane Chunk i Document. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatora logicznego „AND”.

Przykładowe zapytanie na poziomie dokumentu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter lista obiektów: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Przykładowe zapytanie na poziomie fragmentu dla zakresu wartości liczbowych: (year > 2015 AND year <= 2020)

MetadataFilter lista obiektów: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Uwaga: operatory „AND” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości ciągu obsługują tylko warunki „LUB” dla tego samego klucza.

resultsCount integer

Opcjonalnie. Maksymalna liczba zwracanych Chunk. Usługa może zwrócić mniej niż Chunk.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 10 Chunk. Maksymalna liczba określonych wyników to 100.

Treść odpowiedzi

Odpowiedź z corpora.query zawierająca listę odpowiednich fragmentów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
relevantChunks[] object (RelevantChunk)

odpowiednie fragmenty,

Zapis JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metoda: corpora.list

Wyświetla wszystkie Corpora należące do użytkownika.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/corpora

Parametry zapytania

pageSize integer

Opcjonalnie. Maksymalna liczba zwracanych Corpora (na stronę). Usługa może zwrócić mniejszą liczbę Corpora.

Jeśli nie podasz tej wartości, zwrócimy maksymalnie 10 Corpora. Maksymalny limit rozmiaru to 20 Corpora na stronę.

pageToken string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania corpora.list.

Podaj token nextPageToken zwrócony w odpowiedzi jako argument następnego żądania, aby pobrać następną stronę.

Podczas paginacji wszystkie inne parametry przekazane do funkcji corpora.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z usługi corpora.list zawierająca podzieloną na strony listę Corpora. Wyniki są sortowane w kolejności rosnącej według kolumny corpus.create_time.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
corpora[] object (Corpus)

Zwrócone korpusy.

nextPageToken string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zapis JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.get

Pobiera informacje o konkretnym Corpus.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parametry ścieżki

name string

Wymagany. Nazwa Corpus. Przykład: corpora/my-corpus-123 przyjmuje postać corpora/{corpora}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.patch

Aktualizuje Corpus.

Punkt końcowy

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parametry ścieżki

corpus.name string

Niezmienne. Identyfikator. Corpus Nazwa zasobu. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli nazwa jest pusta podczas tworzenia, unikalna nazwa zostanie utworzona na podstawie displayName wraz z 12-znakowym losowym sufiksem. Przykład: corpora/my-awesome-corpora-123a456b789c przyjmuje postać corpora/{corpora}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagany. Lista pól do zaktualizowania. Obecnie ta funkcja umożliwia tylko aktualizowanie displayName.

Jest to lista w pełni kwalifikowanych nazw pól rozdzielonych przecinkami. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
displayName string

Opcjonalnie. Czytelna nazwa wyświetlana dla Corpus. Wyświetlana nazwa nie może mieć więcej niż 512 znaków, w tym spacji. Przykład: „Dokumenty w wyszukiwarce semantycznej”

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.delete

Usuwa Corpus.

Punkt końcowy

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parametry ścieżki

name string

Wymagany. Nazwa zasobu Corpus. Przykład: corpora/my-corpus-123 przyjmuje postać corpora/{corpora}.

Parametry zapytania

force boolean

Opcjonalnie. Jeśli ta wartość jest ustawiona na „true”, wszystkie Document i obiekty powiązane z tym Corpus również zostaną usunięte.

Jeśli ma wartość false (domyślną), zwracany jest błąd FAILED_PRECONDITION, jeśli Corpus zawiera jakiekolwiek znaki Document.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pustym obiektem JSON.

Zasób REST: corpora.permissions

Zasób: Permission

Zasób uprawnień przyznaje użytkownikowi, grupie lub wszystkim użytkownikom internetu dostęp do zasobu interfejsu PaLM API (np. dostrojonego modelu lub korpusu).

Rola to zbiór dozwolonych operacji, które umożliwiają użytkownikom wykonywanie określonych działań na zasobach interfejsu PaLM API. Aby udostępnić je użytkownikom, grupom lub kontom usługi, przypisz role. Przypisanie roli oznacza przyznanie uprawnień, które ta rola zawiera.

Istnieją 3 role koncentryczne. Każda rola jest nadzbiorem dozwolonych operacji poprzedniej roli:

  • czytelnik może używać zasobu (np. dostosowanego modelu, korpusu) do wnioskowania;
  • osoba z uprawnieniami do zapisu ma uprawnienia osoby z uprawnieniami do odczytu, a dodatkowo może edytować i udostępniać pliki;
  • właściciel ma uprawnienia do pisania, a dodatkowo może usuwać;
Pola
name string

Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tylko dane wyjściowe.

granteeType enum (GranteeType)

Opcjonalnie. Niezmienne. Typ beneficjenta.

emailAddress string

Opcjonalnie. Niezmienne. Adres e-mail użytkownika lub grupy, do których odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ odbiorcy uprawnień to EVERYONE.

role enum (Role)

Wymagany. Rola przyznana przez to uprawnienie.

Zapis JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Określa typy podmiotów, którym przyznano to uprawnienie.

Wartości w polu enum
GRANTEE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
USER Reprezentuje użytkownika. Jeśli to ustawienie jest włączone, musisz podać adres e-mail użytkownika.
GROUP Reprezentuje grupę. Jeśli to ustawienie jest włączone, musisz podać adres e-mail grupy.
EVERYONE Oznacza dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji.

Rola

Określa rolę przyznaną przez to uprawnienie.

Wartości w polu enum
ROLE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OWNER Właściciel może używać zasobu, aktualizować go, udostępniać i usuwać.
WRITER Osoba z uprawnieniami do pisania może korzystać z zasobu, aktualizować go i udostępniać.
READER Użytkownik z uprawnieniami do odczytu może korzystać z zasobu.

MetadataFilter

Filtr podany przez użytkownika, który ogranicza pobieranie na podstawie wartości metadanych na poziomie Chunk lub Document. Przykład (genre = drama OR genre = action): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Pola
key string

Wymagany. Klucz metadanych, według którego chcesz filtrować.

conditions[] object (Condition)

Wymagany. Conditions dla danego klucza, które spowodują uruchomienie tego filtra. Wiele Condition jest połączonych operatorami logicznymi LUB.

Zapis JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Warunek

Warunek filtra ma zastosowanie do pojedynczego klucza.

Pola
operation enum (Operator)

Wymagany. Operator zastosowany do danej pary klucz-wartość, aby wywołać warunek.

value Union type
Typ wartości musi być zgodny z typem wartości zdefiniowanym w polu dla odpowiedniego klucza. Jeśli typy wartości nie są spójne, wynikiem będzie pusty zbiór. Jeśli CustomMetadata ma typ wartości StringList, warunek filtrowania powinien używać string_value w połączeniu z operacją INCLUDES/EXCLUDES. W przeciwnym razie wynikiem będzie pusty zbiór. value może mieć tylko jedną z tych wartości:
stringValue string

Wartość ciągu znaków, według której chcesz filtrować metadane.

numericValue number

Wartość liczbowa, według której chcesz filtrować metadane.

Zapis JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operator

Określa prawidłowe operatory, które można zastosować do pary klucz-wartość.

Wartości w polu enum
OPERATOR_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
LESS Obsługiwane przez wartość liczbową.
LESS_EQUAL Obsługiwane przez wartość liczbową.
EQUAL Obsługiwane przez typy danych liczbowych i ciągi znaków.
GREATER_EQUAL Obsługiwane przez wartość liczbową.
GREATER Obsługiwane przez wartość liczbową.
NOT_EQUAL Obsługiwane przez typy danych liczbowych i ciągi znaków.
INCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy CustomMetadata typ wartości dla danego klucza ma stringListValue.
EXCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy CustomMetadata typ wartości dla danego klucza ma stringListValue.

RelevantChunk

Informacje o bloku istotne dla zapytania.

Pola
chunkRelevanceScore number

Chunk trafność w stosunku do zapytania.

chunk object (Chunk)

Chunk powiązane z zapytaniem.

document object (Document)

Document powiązany z fragmentem.

Zapis JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

Zasób REST: corpora

Zasób: Corpus

Corpus to zbiór Document. W ramach projektu można utworzyć maksymalnie 5 korpusów.

Pola
name string

Niezmienne. Identyfikator. Corpus Nazwa zasobu. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 znaków, które są małymi literami, cyframi lub myślnikami (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli nazwa jest pusta podczas tworzenia, unikalna nazwa zostanie utworzona na podstawie displayName wraz z 12-znakowym losowym sufiksem. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie. Czytelna nazwa wyświetlana dla Corpus. Wyświetlana nazwa nie może mieć więcej niż 512 znaków, w tym spacji. Przykład: „Dokumenty w wyszukiwarce semantycznej”

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia Corpus.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji Corpus.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}